akka.http.scaladsl.model

Uri

sealed abstract case class Uri(scheme: String, authority: Authority, path: Path, query: Query, fragment: Option[String]) extends Product with Serializable

An immutable model of an internet URI as defined by http://tools.ietf.org/html/rfc3986. All members of this class represent the *decoded* URI elements (i.e. without percent-encoding).

Source
Uri.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Uri
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Uri(scheme: String, authority: Authority, path: Path, query: Query, fragment: Option[String])

Abstract Value Members

  1. abstract def isEmpty: Boolean

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Uri to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Uri, B)

    Implicit information
    This member is added by an implicit conversion from Uri to ArrowAssoc[Uri] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. val authority: Authority

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def copy(scheme: String = scheme, authority: Authority = authority, path: Path = path, query: Query = query, fragment: Option[String] = fragment): Uri

    Returns a copy of this Uri with the given components.

  12. 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.

  13. def ensuring(cond: (Uri) ⇒ Boolean, msg: ⇒ Any): Uri

    Implicit information
    This member is added by an implicit conversion from Uri to Ensuring[Uri] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (Uri) ⇒ Boolean): Uri

    Implicit information
    This member is added by an implicit conversion from Uri to Ensuring[Uri] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): Uri

    Implicit information
    This member is added by an implicit conversion from Uri to Ensuring[Uri] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): Uri

    Implicit information
    This member is added by an implicit conversion from Uri to Ensuring[Uri] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Uri to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. val fragment: Option[String]

  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def isAbsolute: Boolean

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def isRelative: Boolean

  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. val path: Path

  29. val query: Query

  30. def resolvedAgainst(base: Uri): Uri

    Returns a new absolute Uri that is the result of the resolution process defined by http://tools.

    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.

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

  34. def toHttpRequestTargetOriginForm: Uri

    Converts this URI into an HTTP request target "origin-form" as defined by https://tools.

    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.)

  35. def toRelative: Uri

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

  36. def toString(): String

    Definition Classes
    Uri → AnyRef → Any
  37. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withAuthority(host: String, port: Int): Uri

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

  41. 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.

  42. def withAuthority(authority: Authority): Uri

    Returns a copy of this Uri with the given authority.

  43. def withFragment(fragment: String): Uri

    Returns a copy of this Uri with the given fragment.

  44. def withHost(host: String): Uri

    Returns a copy of this Uri with the given host.

  45. def withHost(host: Host): Uri

    Returns a copy of this Uri with the given host.

  46. def withPath(path: Path): Uri

    Returns a copy of this Uri with the given path.

  47. def withPort(port: Int): Uri

    Returns a copy of this Uri with the given port.

  48. def withQuery(map: Map[String, String]): Uri

    Returns a copy of this Uri with a Query created using the given map.

  49. def withQuery(kvp: (String, String)*): Uri

    Returns a copy of this Uri with a Query created using the given (key, value) tuples.

  50. def withQuery(query: String): Uri

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

  51. def withQuery(query: Query): Uri

    Returns a copy of this Uri with the given query.

  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

  55. def [B](y: B): (Uri, B)

    Implicit information
    This member is added by an implicit conversion from Uri to ArrowAssoc[Uri] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Uri to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (uri: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Uri to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (uri: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Uri

    Implicit information
    This member is added by an implicit conversion from Uri to ArrowAssoc[Uri] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (uri: ArrowAssoc[Uri]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Uri

    Implicit information
    This member is added by an implicit conversion from Uri to Ensuring[Uri] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (uri: Ensuring[Uri]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Uri to StringAdd

Inherited by implicit conversion any2stringfmt from Uri to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Uri to ArrowAssoc[Uri]

Inherited by implicit conversion any2Ensuring from Uri to Ensuring[Uri]

Ungrouped