Package

sttp.client3

circe

Permalink

package circe

Linear Supertypes
SttpCirceApi, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. circe
  2. SttpCirceApi
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait SttpCirceApi extends AnyRef

    Permalink

Value Members

  1. def asJson[B](implicit arg0: Decoder[B], arg1: IsOption[B]): ResponseAs[Either[ResponseException[String, Error], B], Any]

    Permalink

    If the response is successful (2xx), tries to deserialize the body from a string into JSON.

    If the response is successful (2xx), tries to deserialize the body from a string into JSON. Returns:

    • Right(b) if the parsing was successful
    • Left(HttpError(String)) if the response code was other than 2xx (deserialization is not attempted)
    • Left(DeserializationException) if there's an error during deserialization
    Definition Classes
    SttpCirceApi
  2. def asJsonAlways[B](implicit arg0: Decoder[B], arg1: IsOption[B]): ResponseAs[Either[DeserializationException[Error], B], Any]

    Permalink

    Tries to deserialize the body from a string into JSON, regardless of the response code.

    Tries to deserialize the body from a string into JSON, regardless of the response code. Returns:

    • Right(b) if the parsing was successful
    • Left(DeserializationException) if there's an error during deserialization
    Definition Classes
    SttpCirceApi
  3. def asJsonEither[E, B](implicit arg0: Decoder[E], arg1: IsOption[E], arg2: Decoder[B], arg3: IsOption[B]): ResponseAs[Either[ResponseException[E, Error], B], Any]

    Permalink

    Tries to deserialize the body from a string into JSON, using different deserializers depending on the status code.

    Tries to deserialize the body from a string into JSON, using different deserializers depending on the status code. Returns:

    • Right(B) if the response was 2xx and parsing was successful
    • Left(HttpError(E)) if the response was other than 2xx and parsing was successful
    • Left(DeserializationException) if there's an error during deserialization
    Definition Classes
    SttpCirceApi
  4. implicit def circeBodySerializer[B](implicit encoder: Encoder[B], printer: Printer = Printer.noSpaces): BodySerializer[B]

    Permalink
    Definition Classes
    SttpCirceApi
  5. def deserializeJson[B](implicit arg0: Decoder[B], arg1: IsOption[B]): (String) ⇒ Either[Error, B]

    Permalink
    Definition Classes
    SttpCirceApi

Inherited from SttpCirceApi

Inherited from AnyRef

Inherited from Any

Ungrouped