SttpJsoniterJsonApi

sttp.client4.jsoniter.SttpJsoniterJsonApi

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def asJson[B](b: B)(implicit encoder: JsonValueCodec[B]): StringBody

Serialize the given value as JSON, to be used as a request's body using sttp.client4.Request.body.

Serialize the given value as JSON, to be used as a request's body using sttp.client4.Request.body.

Attributes

def asJson[B : IsOption]: ResponseAs[Either[ResponseException[String], B]]

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

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(UnexpectedStatusCode(String)) if the response code was other than 2xx (deserialization is not attempted)
  • Left(DeserializationException) if there's an error during deserialization

Attributes

def asJsonAlways[B : IsOption]: ResponseAs[Either[DeserializationException, B]]

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

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

Attributes

def asJsonEither[E : IsOption, B : IsOption]: ResponseAs[Either[ResponseException[E], B]]

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

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(UnexpectedStatusCode(E)) if the response was other than 2xx and parsing was successful
  • Left(DeserializationException) if there's an error during deserialization

Attributes

def asJsonEitherOrFail[E : IsOption, B : IsOption]: ResponseAs[Either[E, B]]

Deserializes the body from a string into JSON, using different deserializers depending on the status code. If a deserialization error occurs, throws a DeserializationException / returns a failed effect.

Deserializes the body from a string into JSON, using different deserializers depending on the status code. If a deserialization error occurs, throws a DeserializationException / returns a failed effect.

Attributes

def asJsonOrFail[B : IsOption]: ResponseAs[B]

If the response is successful (2xx), tries to deserialize the body from a string into JSON. Otherwise, if the response code is other than 2xx, or a deserialization error occurs, throws an ResponseException / returns a failed effect.

If the response is successful (2xx), tries to deserialize the body from a string into JSON. Otherwise, if the response code is other than 2xx, or a deserialization error occurs, throws an ResponseException / returns a failed effect.

Attributes

def deserializeJson[B : IsOption]: String => Either[JsonReaderException, B]

Implicits

Implicits

implicit def optionDecoder[T : JsonValueCodec]: JsonValueCodec[Option[T]]