sealed abstract case class Uri extends Product with Serializable

An immutable model of an internet URI as defined by https://tools.ietf.org/html/rfc3986. All members of this class represent the *decoded* URI elements (i.e. without percent-encoding), with the exception of 'rawQueryString': rawQueryString should be a string that only contains characters permitted by https://tools.ietf.org/html/rfc3986#section-3.4, any other characters must be percent-encoded (for example through UriParser.parseRawQueryString)

Annotations
@DoNotInherit()
Source
Uri.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Known Subclasses
Empty
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Uri
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def isEmpty: Boolean

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Uri toany2stringadd[Uri] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Uri, B)
    Implicit
    This member is added by an implicit conversion from Uri toArrowAssoc[Uri] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val authority: Authority
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def copy(scheme: String = scheme, authority: Authority = authority, path: Path = path, rawQueryString: Option[String] = rawQueryString, fragment: Option[String] = fragment): Uri

    Returns a copy of this Uri with the given components.

    Returns a copy of this Uri with the given components.

    If you want to use the copy constructor to update the 'rawQueryString', it is up to you to make sure the query string does not contain invalid characters. For this reason we recommend using Uri#withRawQueryString() instead.

  10. def effectivePort: Int

    The effective port of this Uri given the currently set authority and scheme values.

    The effective port of this Uri given the currently set authority and scheme values. If the authority has an explicitly set port (i.e. a non-zero port value) then this port is the effective port. Otherwise the default port for the current scheme is returned.

  11. def ensuring(cond: (Uri) => Boolean, msg: => Any): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Uri) => Boolean): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. val fragment: Option[String]
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def isAbsolute: Boolean
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isRelative: Boolean
  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. val path: Path
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. def query(charset: Charset = UTF8, mode: ParsingMode = Uri.ParsingMode.Relaxed): Query

    Parses the rawQueryString member into a Query instance.

  28. def queryString(charset: Charset = UTF8): Option[String]

    Returns the query part of the Uri in its decoded form.

  29. val rawQueryString: Option[String]
  30. def resolvedAgainst(base: Uri): Uri

    Returns a new absolute Uri that is the result of the resolution process defined by http://tools.ietf.org/html/rfc3986#section-5.2.2 The given base Uri must be absolute.

  31. val scheme: String
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toEffectiveHttpRequestUri(hostHeaderHost: Host, hostHeaderPort: Int, securedConnection: Boolean = false, defaultAuthority: Authority = Authority.Empty): Uri

    Converts this URI to an "effective HTTP request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5

  34. def toEffectiveRequestUri(hostHeaderHost: Host, hostHeaderPort: Int, defaultScheme: String, defaultAuthority: Authority = Authority.Empty): Uri

    Converts this URI to an "effective request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5

  35. def toHttpRequestTargetOriginForm: Uri

    Converts this URI into an HTTP request target "origin-form" as defined by https://tools.ietf.org/html/rfc7230#section-5.3.

    Converts this URI into an HTTP request target "origin-form" as defined by https://tools.ietf.org/html/rfc7230#section-5.3.

    Note that the resulting URI instance is not a valid RFC 3986 URI! (As it might be a "relative" URI with a part component starting with a double slash.)

  36. def toRelative: Uri

    Converts this URI into a relative URI by keeping the path, query and fragment, but dropping the scheme and authority.

  37. def toString(): String
    Definition Classes
    Uri → AnyRef → Any
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. def withAuthority(host: String, port: Int): Uri

    Returns a copy of this Uri with a Authority created using the given host and port.

  42. def withAuthority(host: Host, port: Int, userinfo: String = ""): Uri

    Returns a copy of this Uri with a Authority created using the given host, port and userinfo.

  43. def withAuthority(authority: Authority): Uri

    Returns a copy of this Uri with the given authority.

  44. def withFragment(fragment: String): Uri

    Returns a copy of this Uri with the given fragment.

  45. def withHost(host: String): Uri

    Returns a copy of this Uri with the given host.

  46. def withHost(host: Host): Uri

    Returns a copy of this Uri with the given host.

  47. def withPath(path: Path): Uri

    Returns a copy of this Uri with the given path.

  48. def withPort(port: Int): Uri

    Returns a copy of this Uri with the given port.

  49. def withQuery(query: Query): Uri

    Returns a copy of this Uri with the given query.

  50. def withRawQueryString(rawQueryString: String, mode: ParsingMode): Uri

    Returns a copy of this Uri with the given query string.

    Returns a copy of this Uri with the given query string.

    Characters that are not within the range described at https://tools.ietf.org/html/rfc3986#section-3.4 must be percent-encoded. Characters that are in that range may or may not be percent-encoded, and depending on how the query string is parsed this might be relevant: for example, when interpreting the query string as 'key=value' pairs you could use the percent-encoded '=' ('%22) to include a '=' in the key or value.

    mode

    depending on the mode, characters outside of the range allowed by RFC3986 will either cause an IllegalUriException or be automatically percent-encoded. Be aware that relying on automatic percent-encoding is usually a programming error.

  51. def withRawQueryString(rawQuery: String): Uri

    Returns a copy of this Uri with the given query string.

    Returns a copy of this Uri with the given query string.

    Characters that are not within the range described at https://tools.ietf.org/html/rfc3986#section-3.4 should be percent-encoded. Characters that are in that range may or may not be percent-encoded, and depending on how the query string is parsed this might be relevant: for example, when interpreting the query string as 'key=value' pairs you could use the percent-encoded '=' ('%22) to include a '=' in a key or value.

    When characters are encountered that are outside of the RFC3986 range they are automatically percent-encoded, but be aware that relying on this is usually a programming error.

  52. def withScheme(scheme: String): Uri

    Returns a copy of this Uri with the given scheme.

    Returns a copy of this Uri with the given scheme. The scheme change of the Uri has the following effect on the port value:

    • If the Uri has a non-default port for the scheme before the change this port will remain unchanged.
    • If the Uri has the default port for the scheme before the change it will have the default port for the new scheme after the change.
  53. def withUserInfo(userinfo: String): Uri

    Returns a copy of this Uri with the given userinfo.

  54. def withoutFragment: Uri

    Drops the fragment from this URI

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Uri toStringFormat[Uri] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (Uri, B)
    Implicit
    This member is added by an implicit conversion from Uri toArrowAssoc[Uri] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromUri to any2stringadd[Uri]

Inherited by implicit conversion StringFormat fromUri to StringFormat[Uri]

Inherited by implicit conversion Ensuring fromUri to Ensuring[Uri]

Inherited by implicit conversion ArrowAssoc fromUri to ArrowAssoc[Uri]

Ungrouped