core
1.0.0-M47
API
Generated with
core/org.http4s/Query/Empty

Empty

org.http4s.Query.Empty
case object Empty extends Query

Attributes

Source
Query.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Query
trait Renderable
trait QueryOps
class Object
trait Matchable
class Any
Show all
Self type
Empty.type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton
Source
Mirror.scala

Inherited and Abstract types

type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

def pairs: Vector[KeyValue]

Attributes

Source
Query.scala
override def render(writer: Writer): writer.type

Base method for rendering this object efficiently

Base method for rendering this object efficiently

Attributes

Definition Classes
Source
Query.scala

Inherited methods

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

alias for withQueryParam

alias for withQueryParam

Attributes

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

alias for withQueryParamValue

alias for withQueryParamValue

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala
def ++(pairs: Iterable[(String, Option[String])]): Query

Attributes

Inherited from:
Query
Source
Query.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

Inherited from:
QueryOps
Source
QueryOps.scala
def +:(elem: KeyValue): Query

Attributes

Inherited from:
Query
Source
Query.scala
def +?[K : QueryParamKeyLike](name: K): Self

alias for withQueryParam

alias for withQueryParam

Attributes

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

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
def +??[T : QueryParamEncoder](value: Option[T]): Self

alias for withOptionQueryParam

alias for withOptionQueryParam

Attributes

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

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
def :+(elem: KeyValue): Query

Attributes

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

alias for setQueryParams

alias for setQueryParams

Attributes

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

alias for containsQueryParam

alias for containsQueryParam

Attributes

Inherited from:
QueryOps
Source
QueryOps.scala
def containsQueryParam[K : QueryParamKeyLike](key: K): Boolean

Attributes

Inherited from:
QueryOps
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

Inherited from:
QueryOps
Source
QueryOps.scala
def drop(n: Int): Query

Attributes

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

Attributes

Inherited from:
Query
Source
Query.scala
def exists(f: KeyValue => Boolean): Boolean

Attributes

Inherited from:
Query
Source
Query.scala
def filter(f: KeyValue => Boolean): Query

Attributes

Inherited from:
Query
Source
Query.scala
def filterNot(f: KeyValue => Boolean): Query

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
Query
Source
Query.scala
def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
Source
Mirror.scala
def get(idx: Int): Option[KeyValue]

Attributes

Inherited from:
Query
Source
Query.scala
def isEmpty: Boolean

Attributes

Inherited from:
Query
Source
Query.scala
def length: Int

Attributes

Inherited from:
Query
Source
Query.scala
def nonEmpty: Boolean

Attributes

Inherited from:
Query
Source
Query.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
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

Inherited from:
QueryOps
Source
QueryOps.scala
def renderString: String

Generates a String rendering of this object

Generates a String rendering of this object

Attributes

Inherited from:
Renderable
Source
Renderable.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

Inherited from:
QueryOps
Source
QueryOps.scala
def slice(from: Int, until: Int): Query

Attributes

Inherited from:
Query
Source
Query.scala
def toList: List[(String, Option[String])]

Attributes

Inherited from:
Query
Source
Query.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
def toVector: Vector[(String, Option[String])]

Attributes

Inherited from:
Query
Source
Query.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

Inherited from:
QueryOps
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

Inherited from:
QueryOps
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

Inherited from:
QueryOps
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

Inherited from:
QueryOps
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

Inherited from:
QueryOps
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

Inherited from:
QueryOps
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

Inherited from:
QueryOps
Source
QueryOps.scala
def withQueryParamValue[T : QueryParamEncoder](value: T): 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 value(s) will be replaced.

Attributes

Inherited from:
QueryOps
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

Inherited from:
QueryOps
Source
QueryOps.scala

Inherited fields

lazy val multiParams: Map[String, List[String]]

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

Inherited from:
Query
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

Inherited from:
Query
Source
Query.scala
Generated with