OptionalQueryField

class OptionalQueryField<T>(val inner: QueryField<T>) : QueryField<T?>

A query field that is optional.

Constructors

Link copied to clipboard
constructor(inner: QueryField<T>)

Properties

Link copied to clipboard
open override val fields: List<String>

The field names for this query parameter.

Link copied to clipboard
Link copied to clipboard
open val name: String

Display name for this field, derived from fields.

Functions

Link copied to clipboard
@JvmName(name = "andEmptyQueryFieldRight")
infix fun <A> QueryField<A>.and(other: Empty): QueryField<A>

Creates a pair of query fields as QueryPairField, optimizing for Empty on the right.

infix fun <A, B> QueryField<A>.and(other: QueryField<B>): QueryPairField<A, B>

Creates a pair of query fields as QueryPairField.

Link copied to clipboard
open fun create(value: T?): QueryParams

Creates a QueryParams object from the given value.

Link copied to clipboard
context(_: Raise<Issue>)
open override fun decode(params: QueryParams): T?
Link copied to clipboard
open override fun encodeQuery(value: T?): Map<String, List<String>>
Link copied to clipboard
open override fun flatten(): List<QueryField<*>>

Flattens the QueryField into its constituent fields.

Link copied to clipboard

Marks a query field as optional.