org.http4s

Uri

case class Uri(scheme: Option[CaseInsensitiveString] = None, authority: Option[Authority] = None, path: Path = "/", query: Option[Query] = None, fragment: Option[Fragment] = None) extends Renderable with Product with Serializable

Representation of the Request URI Structure containing information related to a Uri. All fields except the query are expected to be url decoded.

scheme

optional Uri Scheme. eg, http, https

authority

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

path

the Uri path

query

optional Query. Note that the query should _NOT_ be url decoded

fragment

optional Uri Fragment. Note that the fragment should _NOT_ be url decoded

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Uri
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Renderable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    scheme

    optional Uri Scheme. eg, http, https

    authority

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

    path

    the Uri path

    query

    optional Query. Note that the query should _NOT_ be url decoded

    fragment

    optional Uri Fragment. Note that the fragment should _NOT_ be url decoded

Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +?[T](values: T*)(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Uri

    alias for withQueryParam

  4. def +?[T](name: String, values: T*)(implicit arg0: QueryParamEncoder[T]): Uri

    alias for withQueryParam

  5. def +?[T](implicit arg0: QueryParam[T]): Uri

    alias for withQueryParam

  6. def +?(name: String): Uri

    alias for withQueryParam

  7. def +??[T](value: Option[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Uri

    alias for withOptionQueryParam

  8. def +??[T](name: String, value: Option[T])(implicit arg0: QueryParamEncoder[T]): Uri

    alias for withOptionQueryParam

  9. def +??[T](value: Maybe[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Uri

    alias for withMaybeQueryParam

  10. def +??[T](name: String, value: Maybe[T])(implicit arg0: QueryParamEncoder[T]): Uri

    alias for withMaybeQueryParam

  11. def -?[T](implicit arg0: QueryParam[T]): Uri

    alias for removeQueryParam

  12. def -?(name: String): Uri

    alias for removeQueryParam

  13. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def =?[T](q: Map[String, Seq[T]])(implicit arg0: QueryParamEncoder[T]): Uri

    alias for setQueryParams

  15. def ?(name: String): Boolean

    alias for containsQueryParam

  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. val authority: Option[Authority]

    optional Uri Authority.

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

  18. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def containsQueryParam[T](implicit arg0: QueryParam[T]): Boolean

  20. def containsQueryParam(name: String): Boolean

    Checks if a specified parameter exists in query string.

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

  21. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. val fragment: Option[Fragment]

    optional Uri Fragment.

    optional Uri Fragment. Note that the fragment should _NOT_ be url decoded

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

    Definition Classes
    AnyRef → Any
  25. def host: Option[Host]

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. lazy val 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.

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

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

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

    Definition Classes
    AnyRef
  31. lazy val 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

  32. val path: Path

    the Uri path

  33. def port: Option[Int]

  34. val query: Option[Query]

    optional Query.

    optional Query. Note that the query should _NOT_ be url decoded

  35. def removeQueryParam[T](implicit arg0: QueryParam[T]): Uri

    Creates maybe a new Uri without the specified parameter in query string.

    Creates maybe a new Uri without the specified parameter in query string. If no parameter with the given name exists the same Uri will be returned. If the parameter to be removed is not present the existing Uri instance of Uri will be returned.

  36. def removeQueryParam(name: String): Uri

    Creates maybe a new Uri without the specified parameter in query string.

    Creates maybe a new Uri without the specified parameter in query string. If no parameter with the given name exists the same Uri will be returned. If the parameter to be removed is not present the existing Uri instance of Uri will be returned.

  37. def render(writer: Writer): writer.type

    Base method for rendering this object efficiently

    Base method for rendering this object efficiently

    Definition Classes
    UriRenderable
  38. lazy val renderString: String

    Generates a String rendering of this object

    Generates a String rendering of this object

    Definition Classes
    UriRenderable
  39. val scheme: Option[CaseInsensitiveString]

    optional Uri Scheme.

    optional Uri Scheme. eg, http, https

  40. def setQueryParams[T](query: Map[String, Seq[T]])(implicit arg0: QueryParamEncoder[T]): Uri

    Creates maybe a new Uri with the specified parameters.

    Creates maybe a new Uri with the specified parameters. The entire query string will be replaced with the given one. If the given parameters equal the existing the same Uri instance will be returned.

  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  42. def toString(): String

    Definition Classes
    Renderable → Any
  43. def userInfo: Option[UserInfo]

  44. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. def withMaybeQueryParam[T](value: Maybe[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Uri

    Creates maybe a new Uri with the specified parameter in query string.

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

  48. def withMaybeQueryParam[T](name: String, value: Maybe[T])(implicit arg0: QueryParamEncoder[T]): Uri

    Creates maybe a new Uri with the specified parameter in query string.

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

  49. def withOptionQueryParam[T](value: Option[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Uri

    Creates maybe a new Uri with the specified parameter in query string.

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

  50. def withOptionQueryParam[T](name: String, value: Option[T])(implicit arg0: QueryParamEncoder[T]): Uri

    Creates maybe a new Uri with the specified parameter in query string.

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

  51. def withPath(path: Path): Uri

  52. def withQueryParam[T](name: String, values: Seq[T])(implicit arg0: QueryParamEncoder[T]): Uri

    Creates maybe a new Uri with the specified parameter in query string.

    Creates maybe a new Uri with the specified parameter in query string. If a parameter with the given name already exists the values will be replaced. If the parameter to be added equal the existing entry the same instance of Uri will be returned.

  53. def withQueryParam[T](implicit arg0: QueryParam[T]): Uri

    Creates a new Uri with the specified parameter in query string.

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

  54. def withQueryParam(name: String): Uri

    Creates a new Uri with the specified parameter in query string.

    Creates a new Uri with the specified parameter in query string. If a parameter with the given name already exists the values will be replaced with an empty list.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Renderable

Inherited from AnyRef

Inherited from Any

Ungrouped