http4k-core/org.http4k.lens/BiDiPathLens

BiDiPathLens

class BiDiPathLens<FINAL>(meta: Meta, get: (String) -> FINAL, set: (FINAL, Request) -> Request) : LensInjectorExtractor<Request, FINAL> , PathLens<FINAL> (source)

Constructors

BiDiPathLens

constructor(meta: Meta, get: (String) -> FINAL, set: (FINAL, Request) -> Request)

Properties

Functions

and

fun Events.and(next: Events): Events

asResult

fun <IN, OUT> LensExtractor<IN, OUT>.asResult(): LensExtractor<IN, Result<OUT, LensFailure>>

Convert the result of a lens extraction to a Result4k type which

asRouter

fun (Request) -> Boolean.asRouter(name: String = ""): Router

asServer

fun HttpHandler.asServer(config: ServerConfig): Http4kServer

debug

fun HttpHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): HttpHandler

extract

open fun extract(target: Request): FINAL

Lens operation to get the value from the target. Synonym for invoke(IN)

get

open operator fun <R : Request> get(target: R): FINAL

Lens operation to get the value from the target. Synonym for invoke(IN)

inject

open fun <R : Request> inject(value: FINAL, target: R): R

Lens operation to set the value into the target. Synomym for invoke(IN, OUT)

invoke

open operator override fun <R : Request> invoke(value: FINAL, target: R): R

Lens operation to set the value into the target

open operator override fun invoke(target: Request): FINAL

Lens operation to get the value from the target

operator fun invoke(target: String): FINAL

iterator

open operator override fun iterator(): Iterator<Meta>

matches

fun <T> Lens<Request, T>.matches(fn: (T) -> Boolean): Router

Check the content of any lens on a request for routing purposes.

open infix fun <R : Request> of(value: FINAL): (R) -> R

Bind this Lens to a value, so we can set it into a target

ofOrLensFailure

fun <IN : Any, VALUE : Value<T>, T : Any> Lens<IN, String>.ofOrLensFailure(vf: ValueFactory<VALUE, T>, value: String): VALUE

Convert ot throw a lens failure when constructing a value type

restrictFrom

open fun <NEXT : Request> restrictFrom(): LensExtractor<NEXT, FINAL>

Restrict the type that this Lens can extract from

restrictInto

open fun <NEXT : Request> restrictInto(): LensInjector<FINAL, NEXT>

Restrict the type that this Lens can inject into

set

open operator fun <R : Request> set(target: R, value: FINAL): R

Lens operation to set the value into the target. Synomym for invoke(IN, OUT)

withAsyncApi

fun HttpHandler.withAsyncApi(): AsyncHttpHandler

Convert a synchronous HttpHandler API to mimic AsyncHttpClient