Packages

  • package root
    Definition Classes
    root
  • package sttp
    Definition Classes
    root
  • package model

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

    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
    Definition Classes
    sttp
  • package headers
    Definition Classes
    model
  • AcceptEncoding
  • Accepts
  • AuthenticationScheme
  • CacheDirective
  • ContentRange
  • Cookie
  • CookieValueWithMeta
  • CookieWithMeta
  • ETag
  • Origin
  • Range
  • WWWAuthenticateChallenge
  • package internal
    Definition Classes
    model
  • package sse
    Definition Classes
    model
p

sttp.model

headers

package headers

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class AcceptEncoding(encodings: List[WeightedEncoding]) extends Product with Serializable
  2. sealed trait AuthenticationScheme extends AnyRef
  3. sealed trait CacheDirective extends AnyRef
  4. case class ContentRange(unit: String, range: Option[(Long, Long)], size: Option[Long]) extends Product with Serializable
  5. case class Cookie(name: String, value: String) extends Product with Serializable

    A cookie name-value pair.

    A cookie name-value pair.

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

  6. case class CookieValueWithMeta(value: String, expires: Option[Instant], maxAge: Option[Long], domain: Option[String], path: Option[String], secure: Boolean, httpOnly: Boolean, sameSite: Option[SameSite], otherDirectives: Map[String, Option[String]]) extends Product with Serializable
  7. case class CookieWithMeta(name: String, valueWithMeta: CookieValueWithMeta) extends Product with Serializable

    A cookie name-value pair with directives.

    A cookie name-value pair with directives.

    All String values should be already encoded (if necessary), as when serialised, they end up unmodified in the header.

  8. case class ETag(tag: String, weak: Boolean = false) extends Product with Serializable
  9. sealed trait Origin extends AnyRef
  10. case class Range(start: Option[Long], end: Option[Long], unit: String) extends Product with Serializable
  11. case class WWWAuthenticateChallenge(scheme: String, params: ListMap[String, String]) extends Product with Serializable

Value Members

  1. object AcceptEncoding extends Serializable
  2. object Accepts
  3. object AuthenticationScheme
  4. object CacheDirective
  5. object ContentRange extends Serializable
  6. object Cookie extends Serializable

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

  7. object CookieValueWithMeta extends Serializable
  8. object CookieWithMeta extends Serializable
  9. object ETag extends Serializable
  10. object Origin
  11. object Range extends Serializable
  12. object WWWAuthenticateChallenge extends Serializable

Ungrouped