QueryParams

zio.http.QueryParams
See theQueryParams companion object
trait QueryParams

A collection of query parameters.

Attributes

Companion
object
Source
QueryParams.scala
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

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

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

Source
QueryParams.scala
def getAll(key: String): Chunk[String]

Attributes

Source
QueryParams.scala
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
Source
QueryParams.scala
def isEmpty: Boolean

Determines if the query parameters are empty.

Determines if the query parameters are empty.

Attributes

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

Source
QueryParams.scala
def nonEmpty: Boolean

Determines if the query parameters are non-empty.

Determines if the query parameters are non-empty.

Attributes

Source
QueryParams.scala
def normalize: QueryParams

Normalizes the query parameters by removing empty keys and values.

Normalizes the query parameters by removing empty keys and values.

Attributes

Source
QueryParams.scala
override def queryParameters: QueryParams

Attributes

Definition Classes
Source
QueryParams.scala
def toForm: Form

Converts the query parameters into a form.

Converts the query parameters into a form.

Attributes

Source
QueryParams.scala

Inherited methods

def ++(that: QueryParams): QueryParams

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
Source
QueryModifier.scala
def addQueryParam[T](value: T)(implicit schema: Schema[T]): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParam[T](key: String, value: T)(implicit schema: Schema[T]): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParam(key: String): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParam(key: String, value: String): QueryParams

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

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

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParams(queryParams: Iterable[(String, String)]): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParams(values: String): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def addQueryParams(key: String, value: Chunk[String]): QueryParams

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

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

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def hasQueryParam(name: CharSequence): Boolean

Attributes

Inherited from:
QueryChecks
Source
QueryChecks.scala
def query[T](implicit schema: Schema[T]): Either[QueryParamError, T]

Retrieves query parameters as a value of the specified type. The type must have a schema and be a case class and all fields must be query parameters. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Query parameters are selected by field names.

Retrieves query parameters as a value of the specified type. The type must have a schema and be a case class and all fields must be query parameters. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Query parameters are selected by field names.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def query[T](key: String)(implicit schema: Schema[T]): Either[QueryParamError, T]

Retrieves the query parameter with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Retrieves the query parameter with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def queryOrElse[T](default: => T)(implicit schema: Schema[T]): T

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
def queryOrElse[T](key: String, default: => T)(implicit schema: Schema[T]): T

Attributes

Inherited from:
QueryGetters
Source
QueryGetters.scala
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
Source
QueryGetters.scala
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
Source
QueryGetters.scala
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
Source
QueryGetters.scala
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
Source
QueryGetters.scala
def queryZIO[T](key: String)(implicit schema: Schema[T]): IO[QueryParamError, 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
Source
QueryGetters.scala
def removeQueryParam(key: String): QueryParams

Removes the specified key from the query parameters.

Removes the specified key from the query parameters.

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def removeQueryParams(keys: Iterable[String]): QueryParams

Removes the specified keys from the query parameters.

Removes the specified keys from the query parameters.

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def setQueryParams(queryParams: (String, Chunk[String])*): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def setQueryParams(queryParams: Map[String, Chunk[String]]): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def setQueryParams(values: String): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def setQueryParams(values: QueryParams): QueryParams

Attributes

Inherited from:
QueryModifier
Source
QueryModifier.scala
def valueCount(name: CharSequence): Int

Attributes

Inherited from:
QueryChecks
Source
QueryChecks.scala

Inherited and Abstract methods

Deprecated and Inherited methods

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

Deprecated
[Since version 3.1.0] Use query(key)[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala
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

Deprecated
[Since version 3.1.0] Use queryParamOrElse(key, default)
Inherited from:
QueryGetters
Source
QueryGetters.scala
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

Deprecated
[Since version 3.1.0] Use queryZIO(key)[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala
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

Deprecated
[Since version 3.1.0] Use query(key)[Chunk[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala
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

Deprecated
[Since version 3.1.0] Use queryParamsOrElse(key, default)
Inherited from:
QueryGetters
Source
QueryGetters.scala
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

Deprecated
[Since version 3.1.0] Use queryZIO(key)[Chunk[T]
Inherited from:
QueryGetters
Source
QueryGetters.scala