Packages

trait QueryParams extends QueryOps[QueryParams]

A collection of query parameters.

Self Type
QueryParams
Linear Supertypes
QueryOps[QueryParams], QueryChecks[QueryParams], QueryGetters[QueryParams], QueryModifier[QueryParams], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryParams
  2. QueryOps
  3. QueryChecks
  4. QueryGetters
  5. QueryModifier
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def updateQueryParams(f: (QueryParams) => QueryParams): QueryParams
    Definition Classes
    QueryModifier

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ++(that: QueryParams): QueryParams

    Combines two collections of query parameters together.

    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.

    Definition Classes
    QueryModifier
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def addQueryParam[T](value: T)(implicit schema: Schema[T]): QueryParams
    Definition Classes
    QueryModifier
  6. def addQueryParam[T](key: String, value: T)(implicit schema: Schema[T]): QueryParams
    Definition Classes
    QueryModifier
  7. def addQueryParam(key: String): QueryParams
    Definition Classes
    QueryModifier
  8. 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.

    Definition Classes
    QueryModifier
  9. def addQueryParams(queryParams: Iterable[(String, String)]): QueryParams
    Definition Classes
    QueryModifier
  10. def addQueryParams(values: String): QueryParams
    Definition Classes
    QueryModifier
  11. 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.

    Definition Classes
    QueryModifier
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  14. def encode(charset: Charset): String

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

  15. def encode: String

    Encodes the query parameters into a string.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(that: Any): Boolean
    Definition Classes
    QueryParams → AnyRef → Any
  18. def filter(p: (String, Chunk[String]) => Boolean): QueryParams

    Filters the query parameters using the specified predicate.

  19. def getAll(key: String): Chunk[String]
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  21. def hasQueryParam(name: CharSequence): Boolean
    Definition Classes
    QueryChecks
  22. def hashCode(): Int

    Retrieves all query parameter values having the specified name.

    Retrieves all query parameter values having the specified name.

    Definition Classes
    QueryParams → AnyRef → Any
  23. def isEmpty: Boolean

    Determines if the query parameters are empty.

  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def map: Map[String, Chunk[String]]

    All query parameters as a map.

    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.

  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def nonEmpty: Boolean

    Determines if the query parameters are non-empty.

  28. def normalize: QueryParams

    Normalizes the query parameters by removing empty keys and values.

  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  31. def query[T](implicit schema: Schema[T]): Either[QueryParamError, T]

    Retrieves query parameters as a value of the specified type.

    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.

    Definition Classes
    QueryGetters
  32. 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.

    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.

    Definition Classes
    QueryGetters
  33. def queryOrElse[T](default: => T)(implicit schema: Schema[T]): T
    Definition Classes
    QueryGetters
  34. def queryOrElse[T](key: String, default: => T)(implicit schema: Schema[T]): T
    Definition Classes
    QueryGetters
  35. 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.

    Definition Classes
    QueryGetters
  36. 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.

    Definition Classes
    QueryGetters
  37. def queryParameters: QueryParams
    Definition Classes
    QueryParams → QueryGetters
  38. def queryParams(key: String): Chunk[String]

    Retrieves all query parameter values having the specified name.

    Retrieves all query parameter values having the specified name.

    Definition Classes
    QueryGetters
  39. 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.

    Definition Classes
    QueryGetters
  40. 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

    Definition Classes
    QueryGetters
  41. def removeQueryParam(key: String): QueryParams

    Removes the specified key from the query parameters.

    Removes the specified key from the query parameters.

    Definition Classes
    QueryModifier
  42. def removeQueryParams(keys: Iterable[String]): QueryParams

    Removes the specified keys from the query parameters.

    Removes the specified keys from the query parameters.

    Definition Classes
    QueryModifier
  43. def setQueryParams(queryParams: (String, Chunk[String])*): QueryParams
    Definition Classes
    QueryModifier
  44. def setQueryParams(queryParams: Map[String, Chunk[String]]): QueryParams
    Definition Classes
    QueryModifier
  45. def setQueryParams(values: String): QueryParams
    Definition Classes
    QueryModifier
  46. def setQueryParams(values: QueryParams): QueryParams
    Definition Classes
    QueryModifier
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toForm: Form

    Converts the query parameters into a form.

  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. def valueCount(name: CharSequence): Int
    Definition Classes
    QueryChecks
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. 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.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use query(key)[T]

  3. 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.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryParamOrElse(key, default)

  4. 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.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryZIO(key)[T]

  5. 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.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use query(key)[Chunk[T]

  6. 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.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryParamsOrElse(key, default)

  7. 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.

    Definition Classes
    QueryGetters
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) Use queryZIO(key)[Chunk[T]

Inherited from QueryOps[QueryParams]

Inherited from QueryChecks[QueryParams]

Inherited from QueryGetters[QueryParams]

Inherited from QueryModifier[QueryParams]

Inherited from AnyRef

Inherited from Any

Ungrouped