Packages

final case class Uri(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: Path = Uri.Path.empty, query: Query = Query.empty, fragment: Option[Fragment] = None) extends QueryOps with Renderable with Product with Serializable

Representation of the Request URI

scheme

optional Uri Scheme. eg, http, https

authority

optional Uri Authority. eg, localhost:8080, www.foo.bar

path

url-encoded string representation of the path component of the Uri.

query

optional Query. url-encoded.

fragment

optional Uri Fragment. url-encoded.

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

Instance Constructors

  1. new Uri(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: Path = Uri.Path.empty, query: Query = Query.empty, fragment: Option[Fragment] = None)

    scheme

    optional Uri Scheme. eg, http, https

    authority

    optional Uri Authority. eg, localhost:8080, www.foo.bar

    path

    url-encoded string representation of the path component of the Uri.

    query

    optional Query. url-encoded.

    fragment

    optional Uri Fragment. url-encoded.

Value Members

  1. def +*?[T](values: Seq[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  2. def +*?[T](value: T)(implicit arg0: QueryParamKeyLike[T], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  3. def ++?[K, T](param: (K, Seq[T]))(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  4. def +?[K](name: K)(implicit arg0: QueryParamKeyLike[K]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  5. def +?[K, T](param: (K, T))(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  6. def +?[T](implicit arg0: QueryParam[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  7. def +??[T](value: Option[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    alias for withOptionQueryParam

    alias for withOptionQueryParam

    Definition Classes
    QueryOps
  8. def +??[K, T](param: (K, Option[T]))(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    alias for withOptionQueryParam

    alias for withOptionQueryParam

    Definition Classes
    QueryOps
  9. def -?[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Self

    alias for removeQueryParam

    alias for removeQueryParam

    Definition Classes
    QueryOps
  10. def -?[T](implicit key: QueryParam[T]): Self

    alias for removeQueryParam

    alias for removeQueryParam

    Definition Classes
    QueryOps
  11. def /(newSegment: String): Uri

    This is an alias to #addSegment

  12. def =?[T](q: Map[String, List[T]])(implicit arg0: QueryParamEncoder[T]): Self

    alias for setQueryParams

    alias for setQueryParams

    Definition Classes
    QueryOps
  13. def ?[K](name: K)(implicit arg0: QueryParamKeyLike[K]): Boolean

    alias for containsQueryParam

    alias for containsQueryParam

    Definition Classes
    QueryOps
  14. def addPath(morePath: String): Uri

    Splits the path segments and adds each of them to the path url-encoded.

    Splits the path segments and adds each of them to the path url-encoded. A segment is delimited by /

    morePath

    the path to add

    returns

    a new uri with the segments added to the path

  15. def addSegment(newSegment: String): Uri

    Urlencodes and adds a path segment to the Uri

    Urlencodes and adds a path segment to the Uri

    newSegment

    the segment to add.

    returns

    a new uri with the segment added to the path

  16. val authority: Option[Authority]
  17. def containsQueryParam[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Boolean
    Definition Classes
    QueryOps
  18. def containsQueryParam[T](implicit key: QueryParam[T]): Boolean

    Checks if a specified parameter exists in the Query.

    Checks if a specified parameter exists in the Query. A parameter without a name can be checked with an empty string.

    Definition Classes
    QueryOps
  19. val fragment: Option[Fragment]
  20. def host: Option[Host]
  21. def multiParams: Map[String, Seq[String]]

    Representation of the query string as a map

    Representation of the query string as a map

    In case a parameter is available in query string but no value is there the sequence will be empty. If the value is empty the the sequence contains an empty string.

    Examples

    Query StringMap
    ?param=vMap("param" -> Seq("v"))
    ?param=Map("param" -> Seq(""))
    ?paramMap("param" -> Seq())
    ?=valueMap("" -> Seq("value"))
    ?p1=v1&p1=v2&p2=v3&p2=v3Map("p1" -> Seq("v1","v2"), "p2" -> Seq("v3","v4"))

    The query string is lazily parsed. If an error occurs during parsing an empty Map is returned.

  22. def params: Map[String, String]

    View of the head elements of the URI parameters in query string.

    View of the head elements of the URI parameters in query string.

    In case a parameter has no value the map returns an empty string.

    See also

    multiParams

  23. val path: Path
  24. def port: Option[Int]
  25. val query: Query
    Definition Classes
    Uri → QueryOps
  26. def removeQueryParam[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Self

    Creates maybe a new Self without the specified parameter in query.

    Creates maybe a new Self without the specified parameter in query. If no parameter with the given key exists then this will be returned.

    Definition Classes
    QueryOps
  27. def render(writer: Writer): writer.type

    Base method for rendering this object efficiently

    Base method for rendering this object efficiently

    Definition Classes
    Uri → Renderable
  28. lazy val renderString: String

    Generates a String rendering of this object

    Generates a String rendering of this object

    Definition Classes
    Uri → Renderable
  29. def resolve(relative: Uri): Uri
  30. val scheme: Option[Scheme]
  31. def setQueryParams[K, T](params: Map[K, Seq[T]])(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    Creates maybe a new Self with the specified parameters.

    Creates maybe a new Self with the specified parameters. The entire Query will be replaced with the given one.

    Definition Classes
    QueryOps
  32. def toOriginForm: Uri

    Converts this request to origin-form, which is the absolute path and optional query.

    Converts this request to origin-form, which is the absolute path and optional query. If the path is relative, it is assumed to be relative to the root.

  33. def toString(): String
    Definition Classes
    Renderable → Any
  34. def userInfo: Option[UserInfo]
  35. def withFragment(fragment: Fragment): Uri
  36. def withMultiValueQueryParams[T, K](params: Map[K, Seq[T]])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with all the specified parameters in the Query.

    Creates maybe a new Self with all the specified parameters in the Query. If any of the given parameters' keys already exists, the value(s) will be replaced. Parameters from the input map are added left-to-right, so if a parameter with a given key is specified more than once, it will be self-overwriting.

    Definition Classes
    QueryOps
  37. def withOptionQueryParam[T](value: Option[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    Creates maybe a new Self with the specified parameter in the Query.

    Creates maybe a new Self with the specified parameter in the Query. If the value is empty or if the parameter to be added equal the existing entry the same instance of Self will be returned. If a parameter with the given name already exists the values will be replaced.

    Definition Classes
    QueryOps
  38. def withOptionQueryParam[T, K](key: K, value: Option[T])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with the specified parameter in the Query.

    Creates maybe a new Self with the specified parameter in the Query. If the value is empty or if the parameter to be added equal the existing entry the same instance of Self will be returned. If a parameter with the given key already exists the values will be replaced.

    Definition Classes
    QueryOps
  39. def withPath(path: Path): Uri
  40. def withQueryParam[T, K](key: K, values: Seq[T])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with the specified parameters in the Query.

    Creates maybe a new Self with the specified parameters in the Query. If a parameter with the given key already exists the values will be replaced.

    Definition Classes
    QueryOps
  41. def withQueryParam[T, K](key: K, value: T)(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with the specified parameter in the Query.

    Creates maybe a new Self with the specified parameter in the Query. If a parameter with the given key already exists the values will be replaced. If the parameter to be added equal the existing entry the same instance of Self will be returned.

    Definition Classes
    QueryOps
  42. def withQueryParam[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Self

    Creates a new Self with the specified parameter in the Query.

    Creates a new Self with the specified parameter in the Query. If a parameter with the given key already exists the values will be replaced with an empty list.

    Definition Classes
    QueryOps
  43. def withQueryParam[T](implicit arg0: QueryParam[T]): Self

    Creates a new Self with the specified parameter in the Query.

    Creates a new Self with the specified parameter in the Query. If a parameter with the given QueryParam.key already exists the values will be replaced with an empty list.

    Definition Classes
    QueryOps
  44. def withQueryParams[T, K](params: Map[K, T])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with all the specified parameters in the Query.

    Creates maybe a new Self with all the specified parameters in the Query. If any of the given parameters' keys already exists, the value(s) will be replaced. Parameters from the input map are added left-to-right, so if a parameter with a given key is specified more than once, it will be self-overwriting.

    Definition Classes
    QueryOps
  45. def withoutFragment: Uri

Deprecated Value Members

  1. def withPath(path: String): Uri

    Adds the path exactly as described.

    Adds the path exactly as described. Any path element must be urlencoded ahead of time.

    path

    the path string to replace

    Annotations
    @deprecated
    Deprecated

    (Since version 0.22.0-M1) Use {withPath(Uri.Path)} instead