Packages

object Empty extends Uri

Source
Uri.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Empty
  2. Uri
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. val authority: Authority
    Definition Classes
    Uri
  2. 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.

    Definition Classes
    Uri
  3. 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.

    Definition Classes
    Uri
  4. val fragment: Option[String]
    Definition Classes
    Uri
  5. def isAbsolute: Boolean
    Definition Classes
    Uri
  6. def isEmpty: Boolean
    Definition Classes
    EmptyUri
  7. def isRelative: Boolean
    Definition Classes
    Uri
  8. val path: Path
    Definition Classes
    Uri
  9. def productElementNames: Iterator[String]
    Definition Classes
    Product
  10. def query(charset: Charset = UTF8, mode: ParsingMode = Uri.ParsingMode.Relaxed): Query

    Parses the rawQueryString member into a Query instance.

    Parses the rawQueryString member into a Query instance.

    Definition Classes
    Uri
  11. def queryString(charset: Charset = UTF8): Option[String]

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

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

    Definition Classes
    Uri
  12. val rawQueryString: Option[String]
    Definition Classes
    Uri
  13. 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.

    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.

    Definition Classes
    Uri
  14. val scheme: String
    Definition Classes
    Uri
  15. 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

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

    Definition Classes
    Uri
  16. 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

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

    Definition Classes
    Uri
  17. 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.)

    Definition Classes
    Uri
  18. def toRelative: Uri

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

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

    Definition Classes
    Uri
  19. def toString(): String
    Definition Classes
    Uri → AnyRef → Any
  20. def withAuthority(host: String, port: Int): Uri

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

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

    Definition Classes
    Uri
  21. 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.

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

    Definition Classes
    Uri
  22. def withAuthority(authority: Authority): Uri

    Returns a copy of this Uri with the given authority.

    Returns a copy of this Uri with the given authority.

    Definition Classes
    Uri
  23. def withFragment(fragment: String): Uri

    Returns a copy of this Uri with the given fragment.

    Returns a copy of this Uri with the given fragment.

    Definition Classes
    Uri
  24. def withHost(host: String): Uri

    Returns a copy of this Uri with the given host.

    Returns a copy of this Uri with the given host.

    Definition Classes
    Uri
  25. def withHost(host: Host): Uri

    Returns a copy of this Uri with the given host.

    Returns a copy of this Uri with the given host.

    Definition Classes
    Uri
  26. def withPath(path: Path): Uri

    Returns a copy of this Uri with the given path.

    Returns a copy of this Uri with the given path.

    Definition Classes
    Uri
  27. def withPort(port: Int): Uri

    Returns a copy of this Uri with the given port.

    Returns a copy of this Uri with the given port.

    Definition Classes
    Uri
  28. def withQuery(query: Query): Uri

    Returns a copy of this Uri with the given query.

    Returns a copy of this Uri with the given query.

    Definition Classes
    Uri
  29. 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.

    Definition Classes
    Uri
  30. 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.

    Definition Classes
    Uri
  31. 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.
    Definition Classes
    Uri
  32. def withUserInfo(userinfo: String): Uri

    Returns a copy of this Uri with the given userinfo.

    Returns a copy of this Uri with the given userinfo.

    Definition Classes
    Uri
  33. def withoutFragment: Uri

    Drops the fragment from this URI

    Drops the fragment from this URI

    Definition Classes
    Uri