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

case class CookieWithMeta(name: String, valueWithMeta: CookieValueWithMeta) extends Product with Serializable

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.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CookieWithMeta
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CookieWithMeta(name: String, valueWithMeta: CookieValueWithMeta)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. def domain(v: Option[String]): CookieWithMeta
  7. def domain: Option[String]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def expires(v: Option[Instant]): CookieWithMeta
  10. def expires: Option[Instant]
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. def httpOnly(v: Boolean): CookieWithMeta
  13. def httpOnly: Boolean
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def maxAge(v: Option[Long]): CookieWithMeta
  16. def maxAge: Option[Long]
  17. val name: String
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def otherDirective(v: (String, Option[String])): CookieWithMeta
  22. def otherDirectives: Map[String, Option[String]]
  23. def path(v: Option[String]): CookieWithMeta
  24. def path: Option[String]
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def sameSite(s: Option[SameSite]): CookieWithMeta
  27. def sameSite: Option[SameSite]
  28. def secure(v: Boolean): CookieWithMeta
  29. def secure: Boolean
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String

    returns

    Representation of the cookie as in a header value, in the format: [name]=[value]; [directive]=[value]; ....

    Definition Classes
    CookieWithMeta → AnyRef → Any
  32. def value(v: String): CookieWithMeta
  33. def value: String
  34. val valueWithMeta: CookieValueWithMeta
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped