unidocs
0.23.26
API
Generated with
unidocs/org.http4s/QueryOps

QueryOps

org.http4s.QueryOps
trait QueryOps

Attributes

Source
QueryOps.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Query
class Uri

Members list

Type members

Types

protected type Self <: QueryOps

Attributes

Source
QueryOps.scala

Value members

Abstract methods

protected def replaceQuery(query: Query): Self

Attributes

Source
QueryOps.scala
protected def self: Self

Attributes

Source
QueryOps.scala

Concrete methods

def +*?[T : QueryParamEncoder](value: T): Self

alias for withQueryParam

alias for withQueryParam

Attributes

Source
QueryOps.scala
def +*?[T : QueryParamEncoder](values: Seq[T]): Self

alias for withQueryParam

alias for withQueryParam

Attributes

Source
QueryOps.scala
def ++?[K : QueryParamKeyLike, T : QueryParamEncoder](param: (K, Seq[T])): Self

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

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

alias for withQueryParam

alias for withQueryParam

Attributes

Source
QueryOps.scala
def +?[K : QueryParamKeyLike, T : QueryParamEncoder](param: (K, T)): Self

alias for withQueryParam

alias for withQueryParam

Attributes

Source
QueryOps.scala
def +?[K : QueryParamKeyLike](name: K): Self

alias for withQueryParam

alias for withQueryParam

Attributes

Source
QueryOps.scala
def +??[K : QueryParamKeyLike, T : QueryParamEncoder](param: (K, Option[T])): Self

alias for withOptionQueryParam

alias for withOptionQueryParam

Attributes

Source
QueryOps.scala
def +??[T : QueryParamEncoder](value: Option[T]): Self

alias for withOptionQueryParam

alias for withOptionQueryParam

Attributes

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

alias for removeQueryParam

alias for removeQueryParam

Attributes

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

alias for removeQueryParam

alias for removeQueryParam

Attributes

Source
QueryOps.scala
def =?[T : QueryParamEncoder](q: Map[String, List[T]]): Self

alias for setQueryParams

alias for setQueryParams

Attributes

Source
QueryOps.scala
def ?[K : QueryParamKeyLike](name: K): Boolean

alias for containsQueryParam

alias for containsQueryParam

Attributes

Source
QueryOps.scala
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.

Attributes

Source
QueryOps.scala
def removeQueryParam[K : QueryParamKeyLike](key: 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.

Attributes

Source
QueryOps.scala
def setQueryParams[K : QueryParamKeyLike, T : QueryParamEncoder](params: Map[K, Seq[T]]): Self

Creates maybe a new Self with the specified parameters.

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

Source
QueryOps.scala
def withMultiValueQueryParams[T : QueryParamEncoder, K : QueryParamKeyLike](params: Map[K, Seq[T]]): 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.

Attributes

Source
QueryOps.scala
def withOptionQueryParam[T : QueryParamEncoder, K : QueryParamKeyLike](key: K, value: Option[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 key already exists the values will be replaced.

Attributes

Source
QueryOps.scala
def withOptionQueryParam[T : QueryParamEncoder](value: Option[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.

Attributes

Source
QueryOps.scala
def withQueryParam[T : QueryParam]: 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.

Attributes

Source
QueryOps.scala
def withQueryParam[K : QueryParamKeyLike](key: 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.

Attributes

Source
QueryOps.scala
def withQueryParam[T : QueryParamEncoder, K : QueryParamKeyLike](key: K, value: 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 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

Source
QueryOps.scala
def withQueryParam[T : QueryParamEncoder, K : QueryParamKeyLike](key: K, values: Seq[T]): 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.

Attributes

Source
QueryOps.scala
def withQueryParams[T : QueryParamEncoder, K : QueryParamKeyLike](params: Map[K, T]): 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.

Attributes

Source
QueryOps.scala

Abstract fields

protected val query: Query

Attributes

Source
QueryOps.scala
Generated with