Query

org.http4s.Query
See theQuery companion object
sealed trait Query extends QueryOps, Renderable

Representation of a query string.

When a query is none, it is represented by the Query.Empty.

When a query is parsed – it is represented by the Query.Parsed, an indexed sequence of key and maybe value pairs which maps precisely to a query string, modulo percent-encoding. The resulting String will have the pairs separated by '&' while the key is separated from the value with '='.

Otherwise, a query is represented by the Query.Raw containing unparsed string.

Attributes

Companion
object
Source
Query.scala
Graph
Supertypes
trait Renderable
trait QueryOps
class Object
trait Matchable
class Any
Known subtypes
object Empty.type
class Parsed
class Raw

Members list

Value members

Abstract methods

Attributes

Source
Query.scala

Concrete methods

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Attributes

Source
Query.scala
def drop(n: Int): Query

Attributes

Source
Query.scala
def dropRight(n: Int): Query

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Attributes

Source
Query.scala
def foldLeft[Z](z: Z)(f: (Z, KeyValue) => Z): Z

Attributes

Source
Query.scala
def foldRight[Z](z: Eval[Z])(f: (KeyValue, Eval[Z]) => Eval[Z]): Eval[Z]

Attributes

Source
Query.scala
def foreach(f: KeyValue => Unit): Unit

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Attributes

Source
Query.scala
def length: Int

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Attributes

Source
Query.scala

Inherited methods

alias for withQueryParam

alias for withQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for withQueryParam

alias for withQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for withQueryParam

alias for withQueryParam

scala> import org.http4s.implicits._
scala> uri"www.scala.com".++?("key" -> List("value1", "value2", "value3"))
res1: Uri = www.scala.com?key=value1&key=value2&key=value3

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for withQueryParam

alias for withQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for withQueryParam

alias for withQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala
def +?[T : QueryParam]: Self

alias for withQueryParam

alias for withQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for withOptionQueryParam

alias for withOptionQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for withOptionQueryParam

alias for withOptionQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala
def -?[K : QueryParamKeyLike](key: K): Self

alias for removeQueryParam

alias for removeQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala
def -?[T](implicit key: QueryParam[T]): Self

alias for removeQueryParam

alias for removeQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for setQueryParams

alias for setQueryParams

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

alias for containsQueryParam

alias for containsQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala
def containsQueryParam[T](implicit key: QueryParam[T]): Boolean

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

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

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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

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

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

Base method for rendering this object efficiently

Base method for rendering this object efficiently

Attributes

Inherited from:
Renderable
Source
Renderable.scala

Generates a String rendering of this object

Generates a String rendering of this object

Attributes

Inherited from:
Renderable
Source
Renderable.scala

Creates maybe a new Self with the specified parameters. If any of the given parameters' keys already exists, the value(s) will be replaced.

Creates maybe a new Self with the specified parameters. If any of the given parameters' keys already exists, the value(s) will be replaced.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Renderable -> Any
Inherited from:
Renderable
Source
Renderable.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

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.

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.

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala

Concrete fields

Map[String, List[String]] representation of the Query

Map[String, List[String]] representation of the Query

Params are represented as a List[String] and may be empty.

Attributes

Source
Query.scala
lazy val params: Map[String, String]

Map[String, String] representation of the Query

Map[String, String] representation of the Query

If multiple values exist for a key, the first is returned. If none exist, the empty String "" is returned.

Attributes

Source
Query.scala