ktor-server-core/io.ktor.server.routing/PathSegmentOptionalParameterRouteSelector

PathSegmentOptionalParameterRouteSelector

data class PathSegmentOptionalParameterRouteSelector(val name: String, val prefix: String? = null, val suffix: String? = null) : RouteSelector, RoutePathComponent, RouteParameterComponent(source)

Evaluates a route against an optional parameter path segment and captures its value, if any.

Report a problem

Parameters

name

is the name of the parameter to capture values to

prefix

is an optional suffix

suffix

is an optional prefix

Constructors

PathSegmentOptionalParameterRouteSelector

constructor(name: String, prefix: String? = null, suffix: String? = null)

Properties

open override val name: String

val prefix: String?

val suffix: String?

Functions

open suspend override fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation

Evaluates this selector against context and a path segment at segmentIndex.

open override fun toString(): String