ktor-serialization/io.ktor.serialization

Package-level declarations

Types

Configuration for client and server ContentNegotiation plugin

A custom content converter that could be registered in ContentNegotiation plugin for any particular content type Could provide bi-directional conversion implementation. One of the most typical examples of content converter is a JSON content converter that provides both serialization and deserialization

ContentConvertException

open class ContentConvertException(message: String, cause: Throwable? = null) : Exception

JsonConvertException

class JsonConvertException(message: String, cause: Throwable? = null) : ContentConvertException

WebsocketContentConverter

interface WebsocketContentConverter

A custom content converter that could be used in the WebSockets plugin Could provide bi-directional conversion implementation. One of the most typical examples of the content converter is a JSON converter that provides both serialization and deserialization

WebsocketContentConvertException

open class WebsocketContentConvertException(message: String, cause: Throwable? = null) : ContentConvertException

WebsocketConverterNotFoundException

class WebsocketConverterNotFoundException(message: String, cause: Throwable? = null) : WebsocketContentConvertException

WebsocketDeserializeException

class WebsocketDeserializeException(message: String, cause: Throwable? = null, val frame: Frame) : WebsocketContentConvertException

Functions

deserialize

inline suspend fun <T> WebsocketContentConverter.deserialize(content: Frame, charset: Charset = Charsets.UTF_8): T

Deserializes content to the value of type T

suspend fun List<ContentConverter>.deserialize(body: ByteReadChannel, typeInfo: TypeInfo, charset: Charset): Any

serialize

inline suspend fun <T> WebsocketContentConverter.serialize(value: T, charset: Charset = Charsets.UTF_8): Frame

Serializes a value to a WebSocket Frame. This function could throw WebsocketConverterNotFoundException if the value is not suitable for conversion

suitableCharset

fun Headers.suitableCharset(defaultCharset: Charset = Charsets.UTF_8): Charset

Detect suitable charset for an application call by Accept header or fallback to defaultCharset

suitableCharsetOrNull

fun Headers.suitableCharsetOrNull(defaultCharset: Charset = Charsets.UTF_8): Charset?

Detect suitable charset for an application call by Accept header or fallback to null