Package-level declarations

Types

Link copied to clipboard

An exception used to indicate a correct/normal closure of a connection or stream. This is typically used in WebSocket or network communication scenarios where a clean shutdown needs to be distinguished from error conditions.

Link copied to clipboard
typealias FromToDateTime = Pair<DateTime?, DateTime?>

Type alias representing a date-time range with optional start and end times. First element is the "from" date-time, second is the "to" date-time.

Link copied to clipboard
typealias LambdaInputProvider = () -> ERROR CLASS: Symbol not found for Input

A function type that provides an Input instance. This is useful for lazy or deferred input creation in Ktor operations.

Link copied to clipboard
typealias QueryParam = Pair<String, String?>
Link copied to clipboard
typealias QueryParams = Map<String, String?>
Link copied to clipboard
typealias StandardKtorSerialFormat = BinaryFormat

Type alias for the standard serialization format used in Ktor utilities, which is BinaryFormat.

Link copied to clipboard

Type alias for the standard serialization input data type, which is ByteArray.

Link copied to clipboard
@Serializable
value class TemporalFileId(val string: String)

A value class representing a unique identifier for a temporal file. Temporal files are typically used for temporary storage during file upload/processing operations.

Properties

Link copied to clipboard

Converts this string to a correct WebSocket URL by ensuring it starts with "ws://" scheme. If the URL already starts with "ws", it is returned unchanged. If the URL contains a scheme (e.g., "http://"), it is replaced with "ws://". If the URL has no scheme, "ws://" is prepended.

Link copied to clipboard

Converts this FromToDateTime range to URL query parameters. Creates "from" and "to" query parameters with Unix millisecond timestamps.

Link copied to clipboard

Create query part which includes key=value pairs separated with &

Link copied to clipboard
val cbor: ERROR CLASS: Unresolved name: Cbor

A CBOR instance for serialization operations.

Link copied to clipboard

The default subdirectory path for storing temporal files during upload operations.

Link copied to clipboard

Extracts a FromToDateTime range from URL query parameters. Looks for "from" and "to" parameters containing Unix millisecond timestamps.

Link copied to clipboard

Parses this URL query string into a QueryParams map. Splits on '&' to separate parameters and '=' to separate keys from values. Parameters without values will have null as their value.

Link copied to clipboard

The standard Ktor serialization format instance, configured as CBOR.

Functions

Link copied to clipboard
fun buildStandardUrl(basePart: String, subpart: String, parameters: List<QueryParam>): String

Builds a standard URL by combining a base part, subpart, and query parameters as a list. The base and subpart are joined with a '/', and query parameters are appended.

fun buildStandardUrl(basePart: String, subpart: String, parameters: QueryParams = emptyMap()): String

Builds a standard URL by combining a base part, subpart, and optional query parameters. The base and subpart are joined with a '/', and query parameters are appended.

fun buildStandardUrl(basePart: String, subpart: String, vararg parameters: QueryParam): String

Builds a standard URL by combining a base part, subpart, and vararg query parameters. The base and subpart are joined with a '/', and query parameters are appended.

Link copied to clipboard
inline fun <T> StandardKtorSerialFormat.decodeDefault(deserializationStrategy: DeserializationStrategy<T>, input: StandardKtorSerialInputData): T

Decodes data from StandardKtorSerialInputData using the standard format.

Link copied to clipboard
inline fun <T> StandardKtorSerialFormat.decodeHex(deserializationStrategy: DeserializationStrategy<T>, input: String): T

Decodes data from a hex string using the standard binary format.

Link copied to clipboard
fun ERROR CLASS: Symbol not found for Source.downloadToTempFile(fileName: String = UUID.randomUUID().toString(), fileExtension: String? = ".temp", folder: File? = null): File?
Link copied to clipboard
inline fun <T> StandardKtorSerialFormat.encodeDefault(serializationStrategy: SerializationStrategy<T>, data: T): StandardKtorSerialInputData

Encodes data to StandardKtorSerialInputData using the standard format.

Link copied to clipboard
inline fun <T> StandardKtorSerialFormat.encodeHex(serializationStrategy: SerializationStrategy<T>, data: T): String

Encodes data to a hex string using the standard binary format.

Link copied to clipboard

Create query part which includes key=value pairs separated with & and attach to receiver

Link copied to clipboard
expect fun MPPFile.input(): ERROR CLASS: Symbol not found for Input

Creates a Ktor Input from this multiplatform file. Platform-specific implementations handle file reading for each supported platform.

actual fun MPPFile.input(): ERROR CLASS: Symbol not found for Input

Creates a Ktor Input from this multiplatform file. Platform-specific implementations handle file reading for each supported platform.

actual fun MPPFile.input(): ERROR CLASS: Symbol not found for Input

Creates a Ktor Input from this multiplatform file. Platform-specific implementations handle file reading for each supported platform.