PathPairField

class PathPairField<A, B>(val fieldA: PathField<A>, val fieldB: PathField<B>) : KovenPairField<A, B> , PathField<KovenPair<A, B>>

A path field that combines two other path fields.

Constructors

Link copied to clipboard
constructor(fieldA: PathField<A>, fieldB: PathField<B>)

Properties

Link copied to clipboard
open override val fieldA: PathField<A>
Link copied to clipboard
open override val fieldB: PathField<B>
Link copied to clipboard
open override val fields: List<String>

The field name(s) for this field.

Link copied to clipboard
open val name: String

Display name for this field, derived from fields.

Functions

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

Creates a pair of path fields as PathPairField, optimizing for Empty on the right.

infix fun <A, B> PathField<A>.and(other: PathField<B>): PathPairField<A, B>

Creates a pair of path fields as PathPairField.

Link copied to clipboard
open fun createPath(value: KovenPair<A, B>): PathParams

Creates a PathParams object from the given value.

Link copied to clipboard
context(_: Raise<Issue>)
open override fun decode(params: Map<String, String>): KovenPair<A, B>
Link copied to clipboard
open override fun encodePath(value: KovenPair<A, B>): Map<String, String>
Link copied to clipboard
open override fun flatten(): List<PathField<*>>

Flattens the field into its constituent fields.

Link copied to clipboard

Marks a path field as optional.