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
o

sttp.model.Uri

QuerySegmentEncoding

object QuerySegmentEncoding

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

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. val All: Encoding

    Encodes all reserved characters using java.net.URLEncoder.encode().

  5. val Relaxed: Encoding

    Doesn't encode any of the reserved characters, leaving intact all characters allowed in the query string as defined by RFC3986.

  6. val RelaxedWithBrackets: Encoding

    Doesn't encode any of the reserved characters, leaving intact all characters allowed in the query string as defined by RFC3986 as well as the characters [ and ].

    Doesn't encode any of the reserved characters, leaving intact all characters allowed in the query string as defined by RFC3986 as well as the characters [ and ]. These brackets aren't legal in the query part of the URI, but some servers use them unencoded. See https://stackoverflow.com/questions/11490326/is-array-syntax-using-square-brackets-in-url-query-strings-valid for discussion.

  7. val Standard: Encoding

    Encodes only the & and = reserved characters, which are usually used to separate query parameter names and values.

  8. val StandardValue: Encoding

    Encodes only the & reserved character, which is usually used to separate query parameter names and values.

    Encodes only the & reserved character, which is usually used to separate query parameter names and values. The '=' sign is allowed in values.

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