QueryParams

zio.http.QueryParams
See theQueryParams companion object
final case class QueryParams(map: Map[String, Chunk[String]])

A collection of query parameters.

Attributes

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

Members list

Value members

Concrete 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

def add(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

def addAll(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

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
Equals -> Any

Filters the query parameters using the specified predicate.

Filters the query parameters using the specified predicate.

Attributes

def get(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

Retrieves all query parameter values having the specified name.

Retrieves all query parameter values having the specified name.

Attributes

def getAllOrElse(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

def getOrElse(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

override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any

Determines if the query parameters are empty.

Determines if the query parameters are empty.

Attributes

Determines if the query parameters are non-empty.

Determines if the query parameters are non-empty.

Attributes

Normalizes the query parameters by removing empty keys and values.

Normalizes the query parameters by removing empty keys and values.

Attributes

Removes the specified key from the query parameters.

Removes the specified key from the query parameters.

Attributes

Removes the specified keys from the query parameters.

Removes the specified keys from the query parameters.

Attributes

def toForm: Form

Converts the query parameters into a form.

Converts the query parameters into a form.

Attributes

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product