zio-http
API
Generated with
zio-http/zio.http/QueryParams

QueryParams

zio.http.QueryParams
See theQueryParams companion object
trait QueryParams

A collection of query parameters.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def encode: String

Encodes the query parameters into a string.

Encodes the query parameters into a string.

Attributes

def encode(charset: Charset): String

Encodes the query parameters into a string using the specified charset.

Encodes the query parameters into a string using the specified charset.

Attributes

override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
def filter(p: (String, Chunk[String]) => Boolean): QueryParams

Filters the query parameters using the specified predicate.

Filters the query parameters using the specified predicate.

Attributes

def getAll(key: String): Chunk[String]
override def hashCode: Int

Retrieves all query parameter values having the specified name.

Retrieves all query parameter values having the specified name.

Attributes

Definition Classes
Any
def isEmpty: Boolean

Determines if the query parameters are empty.

Determines if the query parameters are empty.

Attributes

def map: Map[String, Chunk[String]]

All query parameters as a map. Note that by default this method constructs the map on access from the underlying storage implementation, so should be used with care. Prefer to use getAll and friends if all you need is to access the values by a known key.

All query parameters as a map. Note that by default this method constructs the map on access from the underlying storage implementation, so should be used with care. Prefer to use getAll and friends if all you need is to access the values by a known key.

Attributes

def nonEmpty: Boolean

Determines if the query parameters are non-empty.

Determines if the query parameters are non-empty.

Attributes

def normalize: QueryParams

Normalizes the query parameters by removing empty keys and values.

Normalizes the query parameters by removing empty keys and values.

Attributes

override def queryParameters: QueryParams

Attributes

Definition Classes
def toForm: Form

Converts the query parameters into a form.

Converts the query parameters into a form.

Attributes

Inherited methods

def ++(that: QueryParams): A

Combines two collections of query parameters together. If there are duplicate keys, the values from both sides are preserved, in order from left-to-right.

Combines two collections of query parameters together. If there are duplicate keys, the values from both sides are preserved, in order from left-to-right.

Attributes

Inherited from:
QueryModifier
def addQueryParam(key: String, value: String): A

Adds the specified key/value pair to the query parameters.

Adds the specified key/value pair to the query parameters.

Attributes

Inherited from:
QueryModifier
def addQueryParams(values: String): A

Attributes

Inherited from:
QueryModifier
def addQueryParams(key: String, value: Chunk[String]): A

Adds the specified key/value pairs to the query parameters.

Adds the specified key/value pairs to the query parameters.

Attributes

Inherited from:
QueryModifier
def hasQueryParam(name: CharSequence): Boolean

Attributes

Inherited from:
QueryChecks
def queryParam(key: String): Option[String]

Retrieves the first query parameter value having the specified name.

Retrieves the first query parameter value having the specified name.

Attributes

Inherited from:
QueryGetters
def queryParamOrElse(key: String, default: => String): String

Retrieves the first query parameter value having the specified name, or else uses the default value.

Retrieves the first query parameter value having the specified name, or else uses the default value.

Attributes

Inherited from:
QueryGetters
def queryParamTo[T](key: String)(implicit codec: TextCodec[T]): Either[QueryParamsError, T]

Retrieves the first typed query parameter value having the specified name.

Retrieves the first typed query parameter value having the specified name.

Attributes

Inherited from:
QueryGetters
def queryParamToOrElse[T](key: String, default: => T)(implicit codec: TextCodec[T]): T

Retrieves the first typed query parameter value having the specified name, or else uses the default value.

Retrieves the first typed query parameter value having the specified name, or else uses the default value.

Attributes

Inherited from:
QueryGetters
def queryParamToZIO[T](key: String)(implicit codec: TextCodec[T]): IO[QueryParamsError, T]

Retrieves the first typed query parameter value having the specified name as ZIO.

Retrieves the first typed query parameter value having the specified name as ZIO.

Attributes

Inherited from:
QueryGetters
def queryParams(key: String): Chunk[String]

Retrieves all query parameter values having the specified name.

Retrieves all query parameter values having the specified name.

Attributes

Inherited from:
QueryGetters
def queryParamsOrElse(key: String, default: => Iterable[String]): Chunk[String]

Retrieves all query parameter values having the specified name, or else uses the default iterable.

Retrieves all query parameter values having the specified name, or else uses the default iterable.

Attributes

Inherited from:
QueryGetters
def queryParamsTo[T](key: String)(implicit codec: TextCodec[T]): Either[QueryParamsError, Chunk[T]]

Retrieves all typed query parameter values having the specified name.

Retrieves all typed query parameter values having the specified name.

Attributes

Inherited from:
QueryGetters
def queryParamsToOrElse[T](key: String, default: => Iterable[T])(implicit codec: TextCodec[T]): Chunk[T]

Retrieves all query parameter values having the specified name, or else uses the default iterable.

Retrieves all query parameter values having the specified name, or else uses the default iterable.

Attributes

Inherited from:
QueryGetters
def queryParamsToZIO[T](key: String)(implicit codec: TextCodec[T]): IO[QueryParamsError, Chunk[T]]

Retrieves all typed query parameter values having the specified name as ZIO.

Retrieves all typed query parameter values having the specified name as ZIO.

Attributes

Inherited from:
QueryGetters
def removeQueryParam(key: String): A

Removes the specified key from the query parameters.

Removes the specified key from the query parameters.

Attributes

Inherited from:
QueryModifier
def removeQueryParams(keys: Iterable[String]): A

Removes the specified keys from the query parameters.

Removes the specified keys from the query parameters.

Attributes

Inherited from:
QueryModifier
def setQueryParams(queryParams: (String, Chunk[String])*): A

Attributes

Inherited from:
QueryModifier
def setQueryParams(queryParams: Map[String, Chunk[String]]): A

Attributes

Inherited from:
QueryModifier
def setQueryParams(values: String): A

Attributes

Inherited from:
QueryModifier
def setQueryParams(values: QueryParams): A

Attributes

Inherited from:
QueryModifier
def updateQueryParams(f: QueryParams => QueryParams): A

Attributes

Inherited from:
QueryModifier
Generated with