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
  • object Uri extends UriInterpolator with Serializable

    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.

    Definition Classes
    model
  • AbsolutePath
  • Authority
  • EmptyPath
  • FragmentEncoding
  • FragmentSegment
  • HostEncoding
  • HostSegment
  • PathSegment
  • PathSegmentEncoding
  • PathSegments
  • QuerySegment
  • QuerySegmentEncoding
  • RelativePath
  • Segment
  • UriContext
  • UserInfo

object QuerySegment

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

Type Members

  1. case class KeyValue(k: String, v: String, keyEncoding: Encoding = QuerySegmentEncoding.Standard, valueEncoding: Encoding = QuerySegmentEncoding.Standard) extends QuerySegment with Product with Serializable

    keyEncoding

    See Plain.encoding

    valueEncoding

    See Plain.encoding

  2. case class Plain(v: String, encoding: Encoding = QuerySegmentEncoding.StandardValue) extends QuerySegment with Product with Serializable

    A query fragment which will be inserted into the query, without and preceding or following separators.

    A query fragment which will be inserted into the query, without and preceding or following separators. Allows constructing query strings which are not (only) &-separated key-value pairs.

    encoding

    How to encode the value, and which characters should be escaped. The RFC3986 standard defines that the query can include these special characters, without escaping:

    /?:@-._~!$&()*+,;=

    See: https://stackoverflow.com/questions/2322764/what-characters-must-be-escaped-in-an-http-query-string https://stackoverflow.com/questions/2366260/whats-valid-and-whats-not-in-a-uri-query

  3. case class Value(v: String, encoding: Encoding = QuerySegmentEncoding.StandardValue) extends QuerySegment with Product with Serializable

    A query fragment which contains only the value, without a key.

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( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped