kord-extensions/dev.kordex.core.commands.converters

Package-level declarations

Types

typealias AutoCompleteCallback = suspend AutoCompleteInteraction.(event: AutoCompleteInteractionCreateEvent) -> Unit?

Type alias representing an autocomplete callable.

abstract class CoalescingConverter<T : Any>(val shouldThrow: Boolean = false, var validator: Validator<T> = null) : MultiNamedInputConverter<List<T>, T, Int> , SlashCommandConverter

Abstract base class for a coalescing converter.

CoalescingToDefaultingConverter

class CoalescingToDefaultingConverter<T : Any>(val coalescingConverter: CoalescingConverter<T>, defaultValue: T, outputError: Boolean = false, newSignatureType: Key? = null, newShowTypeInSignature: Boolean? = null, newErrorType: Key? = null, var validator: Validator<T> = null) : DefaultingCoalescingConverter<T>

A special OptionalConverter that wraps a SingleConverter, effectively turning it into an optional converter with the same logic.

CoalescingToOptionalConverter

class CoalescingToOptionalConverter<T : Any>(val coalescingConverter: CoalescingConverter<T>, newSignatureType: Key? = null, newShowTypeInSignature: Boolean? = null, newErrorType: Key? = null, outputError: Boolean = false, var validator: Validator<T?> = null) : OptionalCoalescingConverter<T>

A special OptionalConverter that wraps a SingleConverter, effectively turning it into an optional converter with the same logic.

Converter

abstract class Converter<InputType, OutputType, NamedInputType : Any, ResultType : Any>(val required: Boolean = true) : KordExKoinComponent

Base class for an argument converter.

ConverterToDefaulting

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ConverterToDefaulting

Opt-in annotation for .toDefaulting() converter functions.

ConverterToMulti

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ConverterToMulti

Opt-in annotation for .toMulti() converter functions.

ConverterToOptional

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ConverterToOptional

Opt-in annotation for .toOptional() converter functions.

DefaultingCoalescingConverter

abstract class DefaultingCoalescingConverter<T : Any>(defaultValue: T, val outputError: Boolean = false, var validator: Validator<T> = null) : MultiNamedInputConverter<List<T>, T, Int> , SlashCommandConverter

Abstract base class for a defaulting coalescing converter.

DefaultingConverter

abstract class DefaultingConverter<T : Any>(defaultValue: T, val outputError: Boolean = false, var validator: Validator<T> = null) : SingleNamedInputConverter<T, T, Boolean> , SlashCommandConverter

Abstract base class for a defaulting converter.

ListConverter

abstract class ListConverter<T : Any>(required: Boolean = true, var validator: Validator<List<T>> = null) : MultiNamedInputConverter<List<T>, List<T>, Int> , SlashCommandConverter

Abstract base class for a multi converter.

Mutator

typealias Mutator<T> = suspend CommandContext.(value: T) -> T?

Type alias representing a mutator callable. Keeps things relatively maintainable.

OptionalCoalescingConverter

abstract class OptionalCoalescingConverter<T : Any>(val outputError: Boolean = false, var validator: Validator<T?> = null) : MultiNamedInputConverter<List<T>, T?, Int> , SlashCommandConverter

Abstract base class for an optional coalescing converter.

OptionalConverter

abstract class OptionalConverter<T : Any>(val outputError: Boolean = false, var validator: Validator<T?> = null) : SingleNamedInputConverter<T, T?, Boolean> , SlashCommandConverter

Abstract base class for an optional single converter.

SingleConverter

abstract class SingleConverter<T : Any>(var validator: Validator<T> = null) : SingleNamedInputConverter<T, T, Boolean> , SlashCommandConverter

Abstract base class for a single converter.

SingleToDefaultingConverter

class SingleToDefaultingConverter<T : Any>(val singleConverter: SingleConverter<T>, defaultValue: T, outputError: Boolean = false, newSignatureType: Key? = null, newShowTypeInSignature: Boolean? = null, newErrorType: Key? = null, var validator: Validator<T> = null) : DefaultingConverter<T>

A special SingleConverter that wraps another SingleConverter, effectively turning it into an optional converter with the same logic, but with a default value if parsing fails.

SingleToListConverter

class SingleToListConverter<T : Any>(required: Boolean = true, val singleConverter: SingleConverter<T>, newSignatureType: Key? = null, newShowTypeInSignature: Boolean? = null, newErrorType: Key? = null, var validator: Validator<List<T>> = null) : ListConverter<T>

A special ListConverter that wraps a SingleConverter, effectively turning it into a list-handling converter with the same logic.

SingleToOptionalConverter

class SingleToOptionalConverter<T : Any>(val singleConverter: SingleConverter<T>, newSignatureType: Key? = null, newShowTypeInSignature: Boolean? = null, newErrorType: Key? = null, outputError: Boolean = false, var validator: Validator<T?> = null) : OptionalConverter<T>

A special OptionalConverter that wraps a SingleConverter, effectively turning it into an optional converter with the same logic.

SlashCommandConverter

interface SlashCommandConverter

Interface representing converters that can be made use of in slash commands.

Validator

typealias Validator<T> = suspend ValidationContext<T>.() -> Unit?

Type alias representing a validator callable. Keeps things relatively maintainable.