ktor-locations

alltypes

annotation class KtorExperimentalLocationsAPI

KtorExperimentalLocationsAPI()

@Target([AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS]) annotation class Location

Location(path: String)
val path: String

class LocationAttributeRouteService : LocationRouteService

LocationAttributeRouteService()
fun findRoute(locationClass: KClass<*>): String?

data class LocationInfo

val klass: KClass<*>
val parent: LocationInfo?
val parentParameter: LocationPropertyInfo?
val path: String
val pathParameters: List<LocationPropertyInfo>
val queryParameters: List<LocationPropertyInfo>

abstract class LocationPropertyInfo

fun equals(other: Any?): Boolean
fun hashCode(): Int
val isOptional: Boolean
val name: String
fun toString(): String

interface LocationRouteService

abstract fun findRoute(locationClass: KClass<*>): String?

class LocationRoutingException : Exception

LocationRoutingException(message: String)

open class Locations

Locations(application: Application)
Locations(application: Application, routeService: LocationRouteService)
class Configuration

Configuration()
var routeService: LocationRouteService?

companion object Feature : ApplicationFeature<Application, Configuration, Locations>

fun install(pipeline: Application, configure: Configuration.() -> Unit): Locations
val key: AttributeKey<Locations>

fun createEntry(parent: Route, locationClass: KClass<*>): Route
fun href(location: Any): String
fun install(pipeline: Application, configure: Configuration.() -> Unit): Locations
val key: AttributeKey<Locations>
val registeredLocations: List<LocationInfo>
fun <T : Any> resolve(locationClass: KClass<*>, call: ApplicationCall): T
fun <T : Any> resolve(locationClass: KClass<*>, parameters: Parameters): T
inline fun <reified T : Any> resolve(parameters: Parameters): T
inline fun <reified T : Any> resolve(call: ApplicationCall): T

io.ktor.application.Application

val Application.locations: Locations

io.ktor.application.ApplicationCall

inline fun <reified T : Any> ApplicationCall.location(): T
inline fun <reified T : Any> ApplicationCall.locationOrNull(): T
val ApplicationCall.locations: Locations
fun ApplicationCall.url(location: Any, block: URLBuilder.() -> Unit = {}): String

io.ktor.routing.Route

inline fun <reified T : Any> Route.delete(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.get(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.handle(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
fun <T : Any> Route.handle(dataClass: KClass<T>, body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
inline fun <reified T : Any> Route.head(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.location(noinline body: Route.() -> Unit): Route
fun <T : Any> Route.location(data: KClass<T>, body: Route.() -> Unit): Route
inline fun <reified T : Any> Route.options(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.patch(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.post(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.put(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

io.ktor.util.pipeline.PipelineContext

fun PipelineContext<Unit, ApplicationCall>.href(location: Any): String
val PipelineContext<Unit, ApplicationCall>.locations: Locations

package io.ktor.locations

annotation class KtorExperimentalLocationsAPI

KtorExperimentalLocationsAPI()

@Target([AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS]) annotation class Location

Location(path: String)
val path: String

class LocationAttributeRouteService : LocationRouteService

LocationAttributeRouteService()
fun findRoute(locationClass: KClass<*>): String?

data class LocationInfo

val klass: KClass<*>
val parent: LocationInfo?
val parentParameter: LocationPropertyInfo?
val path: String
val pathParameters: List<LocationPropertyInfo>
val queryParameters: List<LocationPropertyInfo>

abstract class LocationPropertyInfo

fun equals(other: Any?): Boolean
fun hashCode(): Int
val isOptional: Boolean
val name: String
fun toString(): String

interface LocationRouteService

abstract fun findRoute(locationClass: KClass<*>): String?

class LocationRoutingException : Exception

LocationRoutingException(message: String)

open class Locations

Locations(application: Application)
Locations(application: Application, routeService: LocationRouteService)
class Configuration

Configuration()
var routeService: LocationRouteService?

companion object Feature : ApplicationFeature<Application, Configuration, Locations>

fun install(pipeline: Application, configure: Configuration.() -> Unit): Locations
val key: AttributeKey<Locations>

fun createEntry(parent: Route, locationClass: KClass<*>): Route
fun href(location: Any): String
fun install(pipeline: Application, configure: Configuration.() -> Unit): Locations
val key: AttributeKey<Locations>
val registeredLocations: List<LocationInfo>
fun <T : Any> resolve(locationClass: KClass<*>, call: ApplicationCall): T
fun <T : Any> resolve(locationClass: KClass<*>, parameters: Parameters): T
inline fun <reified T : Any> resolve(parameters: Parameters): T
inline fun <reified T : Any> resolve(call: ApplicationCall): T

io.ktor.application.Application

val Application.locations: Locations

io.ktor.application.ApplicationCall

inline fun <reified T : Any> ApplicationCall.location(): T
inline fun <reified T : Any> ApplicationCall.locationOrNull(): T
val ApplicationCall.locations: Locations
fun ApplicationCall.url(location: Any, block: URLBuilder.() -> Unit = {}): String

io.ktor.routing.Route

inline fun <reified T : Any> Route.delete(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.get(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.handle(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
fun <T : Any> Route.handle(dataClass: KClass<T>, body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
inline fun <reified T : Any> Route.head(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.location(noinline body: Route.() -> Unit): Route
fun <T : Any> Route.location(data: KClass<T>, body: Route.() -> Unit): Route
inline fun <reified T : Any> Route.options(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.patch(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.post(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.put(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route

io.ktor.util.pipeline.PipelineContext

fun PipelineContext<Unit, ApplicationCall>.href(location: Any): String
val PipelineContext<Unit, ApplicationCall>.locations: Locations