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].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 internal
    Definition Classes
    model
  • package ws
    Definition Classes
    model
  • Cookie
  • CookieValueWithMeta
  • CookieWithMeta
  • HasHeaders
  • Header
  • HeaderNames
  • Headers
  • MediaType
  • MediaTypes
  • Method
  • Methods
  • Part
  • QueryParams
  • StatusCode
  • StatusCodes
  • Uri
  • UriInterpolator

object Uri extends UriInterpolator with Serializable

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.

Linear Supertypes
Serializable, Serializable, UriInterpolator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Uri
  2. Serializable
  3. Serializable
  4. UriInterpolator
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Encoding = (String) ⇒ String
  2. sealed trait QuerySegment extends AnyRef
  3. case class Segment(v: String, encoding: Encoding) extends Product with Serializable
  4. case class UserInfo(username: String, password: Option[String]) extends Product with Serializable
  5. implicit class UriContext extends AnyRef
    Definition Classes
    UriInterpolator

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. def apply(javaUri: URI): Uri
  5. def apply(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Uri
  6. def apply(scheme: String, host: String, path: Seq[String], fragment: Option[String]): Uri
  7. def apply(scheme: String, host: String, path: Seq[String]): Uri
  8. def apply(scheme: String, host: String, port: Int, path: Seq[String]): Uri
  9. def apply(scheme: String, host: String, port: Int): Uri
  10. def apply(scheme: String, host: String): Uri
  11. def apply(host: String, port: Int, path: Seq[String]): Uri
  12. def apply(host: String, port: Int): Uri
  13. def apply(host: String): Uri
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def parse(uri: String): Either[String, Uri]
  26. def safeApply(scheme: String, userInfo: Option[UserInfo], hostSegment: Segment, port: Option[Int], pathSegments: Seq[Segment], querySegments: Seq[QuerySegment], fragmentSegment: Option[Segment]): Either[String, Uri]
  27. def safeApply(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Either[String, Uri]
  28. def safeApply(scheme: String, host: String, path: Seq[String], fragment: Option[String]): Either[String, Uri]
  29. def safeApply(scheme: String, host: String, path: Seq[String]): Either[String, Uri]
  30. def safeApply(scheme: String, host: String, port: Int, path: Seq[String]): Either[String, Uri]
  31. def safeApply(scheme: String, host: String, port: Int): Either[String, Uri]
  32. def safeApply(scheme: String, host: String): Either[String, Uri]
  33. def safeApply(host: String, port: Int, path: Seq[String]): Either[String, Uri]
  34. def safeApply(host: String, port: Int): Either[String, Uri]
  35. def safeApply(host: String): Either[String, Uri]
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. def unsafeApply(scheme: String, userInfo: Option[UserInfo], hostSegment: Segment, port: Option[Int], pathSegments: Seq[Segment], querySegments: Seq[QuerySegment], fragmentSegment: Option[Segment]): Uri
  39. def unsafeApply(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Uri
  40. def unsafeApply(scheme: String, host: String, path: Seq[String], fragment: Option[String]): Uri
  41. def unsafeApply(scheme: String, host: String, path: Seq[String]): Uri
  42. def unsafeApply(scheme: String, host: String, port: Int, path: Seq[String]): Uri
  43. def unsafeApply(scheme: String, host: String, port: Int): Uri
  44. def unsafeApply(scheme: String, host: String): Uri
  45. def unsafeApply(host: String, port: Int, path: Seq[String]): Uri
  46. def unsafeApply(host: String, port: Int): Uri
  47. def unsafeApply(host: String): Uri
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  51. object FragmentEncoding
  52. object FragmentSegment
  53. object HostEncoding
  54. object HostSegment
  55. object PathSegment
  56. object PathSegmentEncoding
  57. object QuerySegment
  58. object QuerySegmentEncoding

Deprecated Value Members

  1. def notValidated(scheme: String, userInfo: Option[UserInfo], hostSegment: Segment, port: Option[Int], pathSegments: Seq[Segment], querySegments: Seq[QuerySegment], fragmentSegment: Option[Segment]): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  2. def notValidated(scheme: String, userInfo: Option[UserInfo], host: String, port: Option[Int], path: Seq[String], querySegments: Seq[QuerySegment], fragment: Option[String]): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  3. def notValidated(scheme: String, host: String, path: Seq[String], fragment: Option[String]): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  4. def notValidated(scheme: String, host: String, path: Seq[String]): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  5. def notValidated(scheme: String, host: String, port: Int, path: Seq[String]): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  6. def notValidated(scheme: String, host: String, port: Int): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  7. def notValidated(scheme: String, host: String): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  8. def notValidated(host: String, port: Int, path: Seq[String]): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  9. def notValidated(host: String, port: Int): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

  10. def notValidated(host: String): Uri
    Annotations
    @deprecated
    Deprecated

    use apply

Inherited from Serializable

Inherited from Serializable

Inherited from UriInterpolator

Inherited from AnyRef

Inherited from Any

Ungrouped