core/sttp.model

sttp.model

package sttp.model

Most model classes contain both serialisation & parsing functionality, following these conventions:

  • .toString returns a representation of the model class in a format as in an HTTP request/response. For example, for an uri this will be http://..., for a header [name]: [value], etc.
  • [SthCompanionObject].parse(serialized: String): Either[String, Sth]: returns an error message or an instance of the model class
  • [SthCompanionObject].unsafeParse(serialized: String): Sth: returns an instance of the model class or in case of an error, throws an exception.
  • [SthCompanionObject].unsafeApply(values): creates an instance of the model class; validates the input values and in case of an error, throws an exception. An error could be e.g. that the input values contain characters outside of the allowed range
  • [SthCompanionObject].safeApply(...): Either[String, Sth]: same as above, but doesn't throw exceptions. Instead, returns an error message or the model class instance
  • [SthCompanionObject].apply(...): Sth: creates the model type, without validation, and without throwing exceptions

Type members

Classlikes

trait ContentRangeUnits
Companion:
object
object ContentRangeUnits extends ContentRangeUnits
Companion:
class
case class ContentTypeRange(mainType: String, subType: String, charset: String)
Companion:
object
object ContentTypeRange
Companion:
class
trait Encodings
Companion:
object
object Encodings extends Encodings
Companion:
class
trait HasHeaders
class Header(val name: String, val value: String)

An HTTP header. The name property is case-insensitive during equality checks.

An HTTP header. The name property is case-insensitive during equality checks.

To compare if two headers have the same name, use the is method, which does a case-insensitive check, instead of comparing the name property.

The name and value should be already encoded (if necessary), as when serialised, they end up unmodified in the header.

Companion:
object
object Header

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

Companion:
class
trait HeaderNames
Companion:
object
object HeaderNames extends HeaderNames
Companion:
class
case class Headers(headers: Seq[Header]) extends HasHeaders
Companion:
object
object Headers
Companion:
class
case class MediaType(mainType: String, subType: String, charset: Option[String], otherParameters: Map[String, String])
Companion:
object
object MediaType extends MediaTypes

For a description of the behavior of apply, parse, safeApply and unsafeApply methods, see sttp.model.

For a description of the behavior of apply, parse, safeApply and unsafeApply methods, see sttp.model.

Companion:
class
trait MediaTypes
final case class Method(method: String) extends AnyVal
Companion:
object
object Method extends Methods

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

Companion:
class
trait Methods
case class Part[+T](name: String, body: T, otherDispositionParams: Map[String, String], headers: Seq[Header]) extends HasHeaders

A decoded representation of a multipart part.

A decoded representation of a multipart part.

Companion:
object
object Part
Companion:
class
case class QueryParams(ps: Seq[(String, Seq[String])])

Represents query parameters, where each parameter can have 0, 1, or more values. All query parameters are assumed to be decoded.

Represents query parameters, where each parameter can have 0, 1, or more values. All query parameters are assumed to be decoded.

Companion:
object
object QueryParams
Companion:
class
trait RequestMetadata extends HasHeaders
Companion:
object
object RequestMetadata
Companion:
class
trait ResponseMetadata extends HasHeaders
Companion:
object
object ResponseMetadata
Companion:
class
final class StatusCode(val code: Int) extends AnyVal
Companion:
object
object StatusCode extends StatusCodes

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

Companion:
class
trait StatusCodes
case class Uri(scheme: Option[String], authority: Option[Authority], pathSegments: PathSegments, querySegments: Seq[QuerySegment], fragmentSegment: Option[Segment])

A URI. Can represent both relative and absolute URIs, hence in terms of https://tools.ietf.org/html/rfc3986, this is a URI reference.

A URI. Can represent both relative and absolute URIs, hence in terms of https://tools.ietf.org/html/rfc3986, this is a URI reference.

All components (scheme, host, query, ...) are stored decoded, and become encoded upon serialization (using toString).

Instances can be created using the uri interpolator: uri"..." (see UriInterpolator), or the factory methods on the Uri companion object.

The apply/safeApply/unsafeApply methods create absolute URIs and require a host. The relative methods creates a relative URI, given path/query/fragment components.

Value parameters:
querySegments

Either key-value pairs, single values, or plain query segments. Key value pairs will be serialized as k=v, and blocks of key-value pairs/single values will be combined using &. Note that no & or other separators are added around plain query segments - if required, they need to be added manually as part of the plain query segment. Custom encoding logic can be provided when creating a segment.

Companion:
object
object Uri extends UriInterpolator

For a general description of the behavior of apply, parse, safeApply and unsafeApply methods, see sttp.model.

For a general description of the behavior of apply, parse, safeApply and unsafeApply methods, see sttp.model.

The safeApply methods return a validation error if the scheme contains illegal characters or if the host is empty.

Companion:
class
trait UriInterpolator
Companion:
object
object UriInterpolator
Companion:
class