case class Query[T](name: String, flagValue: Option[T], codec: Codec[List[String], T, CodecFormat], info: Info[T]) extends Atom[T] with Product with Serializable
- Alphabetic
- By Inheritance
- Query
- Serializable
- Product
- Equals
- Atom
- Atom
- Basic
- Basic
- Single
- EndpointInput
- EndpointTransput
- EndpointTransputMacros
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Query(name: String, flagValue: Option[T], codec: Codec[List[String], T, CodecFormat], info: Info[T])
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def /[U, TU](other: EndpointInput[U])(implicit concat: typelevel.ParamConcat.Aux[T, U, TU]): EndpointInput[TU]
- Definition Classes
- EndpointInput
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def and[U, TU](other: EndpointInput[U])(implicit concat: typelevel.ParamConcat.Aux[T, U, TU]): EndpointInput[TU]
- Definition Classes
- EndpointInput
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def attribute[A](k: AttributeKey[A], v: A): ThisType[T]
- Definition Classes
- Atom
- def attribute[A](k: AttributeKey[A]): Option[A]
- Definition Classes
- Atom
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val codec: Codec[List[String], T, CodecFormat]
- def default(d: T): ThisType[T]
- Definition Classes
- Atom
- def deprecated(): ThisType[T]
- Definition Classes
- Atom
- def description(d: String): ThisType[T]
- Definition Classes
- Atom
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def example(example: Example[T]): ThisType[T]
- Definition Classes
- Atom
- def example(t: T): ThisType[T]
- Definition Classes
- Atom
- def examples(examples: List[Example[T]]): ThisType[T]
- Definition Classes
- Atom
- def flagValue(v: T): Query[T]
Indicates that this query parameter can be used as a flag in the URI (that is, the query string will contain just the name, without a value).
Indicates that this query parameter can be used as a flag in the URI (that is, the query string will contain just the name, without a value). When used as a flag, its decoded value is
v. - val flagValue: Option[T]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val info: Info[T]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def map[U](mapping: Mapping[T, U]): ThisType[U]
- Definition Classes
- Atom → EndpointTransput
- def map[U](f: (T) => U)(g: (U) => T): ThisType[U]
- Definition Classes
- EndpointTransput
- def mapDecode[U](f: (T) => DecodeResult[U])(g: (U) => T): ThisType[U]
- Definition Classes
- EndpointTransput
- macro def mapTo[CASE_CLASS]: ThisType[CASE_CLASS]
- Definition Classes
- EndpointTransputMacros
- def mapValidate[U](v: Validator[T])(f: (T) => U)(g: (U) => T): ThisType[U]
Adds the given validator, and maps to the given higher-level type
U.Adds the given validator, and maps to the given higher-level type
U.Unlike a
.validate(v).map(f)(g)invocation, during decoding the validator is run before applying theffunction. If there are validation errors, decoding fails. However, the validator is then invoked again on the fully decoded value.This is useful to create inputs/outputs for types, which are unrepresentable unless the validator's condition is met, e.g. due to preconditions in the constructor.
- Definition Classes
- EndpointTransput
- See also
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def schema(modify: (Schema[T]) => Schema[T]): ThisType[T]
- Definition Classes
- Atom
- def schema(s: Option[Schema[T]]): ThisType[T]
- Definition Classes
- Atom
- def schema(s: Schema[T]): ThisType[T]
- Definition Classes
- Atom
- def show: String
- Definition Classes
- Query → EndpointTransput
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def validate(v: Validator[T]): ThisType[T]
Adds a validator.
Adds a validator.
Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by validations. Hence any functions provided in subsequent
.maps or.mapDecodes will be invoked before validation.- Definition Classes
- EndpointTransput
- See also
- def validateIterable[C[X] <: Iterable[X], U](v: Validator[U])(implicit tIsCU: =:=[T, C[U]]): ThisType[T]
Adds a validator which validates each element in the collection.
Adds a validator which validates each element in the collection.
Should only be used if the schema hasn't been created by
.mapping another one, but directly fromSchema[U]. Otherwise the shape of the schema doesn't correspond to the typeT, but to some lower-level representation of the type. This might cause invalid results at run-time.- Definition Classes
- Atom
- def validateOption[U](v: Validator[U])(implicit tIsOptionU: =:=[T, Option[U]]): ThisType[T]
Adds a validator which validates the option's element, if it is present.
Adds a validator which validates the option's element, if it is present.
Should only be used if the schema hasn't been created by
.mapping another one, but directly fromSchema[U]. Otherwise the shape of the schema doesn't correspond to the typeT, but to some lower-level representation of the type. This might cause invalid results at run-time.- Definition Classes
- Atom
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated