ktor-resources/io.ktor.resources.serialization/ResourcesFormat

ResourcesFormat

class ResourcesFormat(serializersModule: SerializersModule) : SerialFormat

A format to (de)serialize resources instances

Constructors

ResourcesFormat

fun ResourcesFormat(serializersModule: SerializersModule = EmptySerializersModule)

Types

data class Parameter(name: String, isOptional: Boolean)

A query parameter description

Functions

decodeFromParameters

fun <T> decodeFromParameters(deserializer: KSerializer<T>, parameters: Parameters): T

Builds a T resource instance from parameters

encodeToParameters

fun <T> encodeToParameters(serializer: KSerializer<T>, value: T): Parameters

Builds Parameters for a resource T

encodeToPathPattern

fun <T> encodeToPathPattern(serializer: KSerializer<T>): String

Builds a path pattern for a given serializer

encodeToQueryParameters

fun <T> encodeToQueryParameters(serializer: KSerializer<T>): Set<ResourcesFormat.Parameter>

Builds a description of query parameters for a given serializer

Properties

serializersModule

open override val serializersModule: SerializersModule