Utilities/mtctx.utilities

Package-level declarations

Types

abstract class CustomByteArraySerializable

Abstract base class for types that can be serialized to a ByteArray.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.LOCAL_VARIABLE])

annotation class Ignore(val reason: IgnoreReason)

Marks code elements that should be ignored by the reader.

IgnoredException

class IgnoredException(reason: IgnoreReason) : Exception

An exception thrown when an element marked with Ignore is accessed or processed, indicating the reason.

IgnoreReason

enum IgnoreReason : Enum<IgnoreReason>

Lists reasons for marking code elements to be ignored by the reader, as used by the Ignore annotation.

Outcome

sealed interface Outcome<out T>

Represents the result of an operation that can either succeed with a value or fail with an error.

Properties

fileSystem

val fileSystem: FileSystem

The default FileSystem instance for file operations, using the system's native file system.

Functions

deserialize

fun <T> String.deserialize(deserializer: KSerializer<T>, format: StringFormat = jsonForMachines): T

Deserializes this string to an object of type T using the specified deserializer and format.

failure

fun failure(outcome: Outcome<*>? = null): Outcome.Failure

Creates a Failure with an optional nested outcome.

fun failure(throwable: Throwable, outcome: Outcome<*>? = null): Outcome.Failure

Creates a Failure with the specified throwable and optional nested outcome.

fun failure(message: String, throwable: Throwable? = null, outcome: Outcome<*>? = null): Outcome.Failure

Creates a Failure with the specified message, throwable, and optional nested outcome.

flatMap

inline suspend fun <T, R> Outcome<T>.flatMap(transform: suspend (T) -> Outcome<R>): Outcome<R>

Flat-maps the value of a successful Outcome using the provided transform function.

fold

inline suspend fun <T, R> Outcome<T>.fold(onSuccess: suspend (T) -> R, onFailure: suspend (String, Throwable?) -> R): R

Folds the Outcome into a single value by applying onSuccess for a Success or onFailure for a Failure.

ignore

fun ignore(reason: IgnoreReason): IgnoreReason

Returns the specified IgnoreReason for use in code or annotations.

ignoreAndThrow

fun ignoreAndThrow(reason: IgnoreReason): Nothing

Throws an IgnoredException with the specified reason.

map

inline suspend fun <T, R> Outcome<T>.map(transform: suspend (T) -> R): Outcome<R>

Maps the value of a successful Outcome using the provided transform function.

mapCatching

inline suspend fun <T, R> Outcome<T>.mapCatching(transform: suspend (T) -> R): Outcome<R>

Maps the value of a successful Outcome using the provided transform function, catching any exceptions.

mapFailure

inline suspend fun <T> Outcome<T>.mapFailure(transform: suspend (Outcome.Failure) -> Outcome.Failure): Outcome<T>

Maps a Failure using the provided transform function, leaving Success unchanged.

padTo

fun ByteArray.padTo(len: Int): ByteArray

Pads this ByteArray to the specified length with zeros if it is too short.

prepend

fun ByteArray.prepend(prefix: ByteArray): ByteArray

Prepends a prefix ByteArray to this ByteArray.

readAndDeserialize

suspend fun <T> File.readAndDeserialize(deserializer: KSerializer<T>, format: StringFormat = jsonForMachines): Outcome<T>

Reads the content of the specified File and deserializes it to an object of type T.

suspend fun <T> Path.readAndDeserialize(deserializer: KSerializer<T>, format: StringFormat = jsonForMachines): Outcome<T>

Reads the content of the specified Path and deserializes it to an object of type T.

recover

inline suspend fun <T> Outcome<T>.recover(recoverBlock: suspend (Outcome.Failure) -> T): Outcome<T>

Recovers from a Failure by applying the recoverBlock function to produce a new value.

recoverCatching

inline suspend fun <T> Outcome<T>.recoverCatching(recoverBlock: suspend (Outcome.Failure) -> T): Outcome<T>

Recovers from a Failure by applying the recoverBlock function, catching any exceptions.

runCatchingOutcomeBlock

inline suspend fun <T> runCatchingOutcomeBlock(block: suspend () -> Outcome<T>): Outcome<T>

Executes the block that returns an Outcome, catching any exceptions.

runCatchingOutcomeBlock

inline suspend fun <T> T.runCatchingOutcomeBlock(block: suspend () -> Outcome<T>): Outcome<T>

Executes the block that returns an Outcome, using this value as context, catching any exceptions.

runCatchingOutcomeOf

inline suspend fun <T> runCatchingOutcomeOf(block: suspend () -> T): Outcome<T>

Executes the block and wraps the result in an Outcome.

runCatchingOutcomeOf

inline suspend fun <T> T.runCatchingOutcomeOf(block: suspend () -> T): Outcome<T>

Executes the block and wraps the result in an Outcome, using this value as context.

serialize

fun <T> T.serialize(serializer: KSerializer<T>, format: StringFormat = jsonForMachines): String

Serializes this object to a string using the specified serializer and format.

serializeAndWrite

suspend fun <T> T.serializeAndWrite(serializer: KSerializer<T>, path: Path, append: Boolean = true, atomicMove: Boolean = false, format: StringFormat = jsonForMachines): Outcome<T>

Serializes this object and writes it to the specified path.

serializersModuleBuilder

fun serializersModuleBuilder(serializersModuleBuilder: SerializersModuleBuilder.() -> Unit): SerializersModuleBuilder.() -> Unit

Wraps a SerializersModuleBuilder lambda for use in serialization configurations.

sibling

fun Path.sibling(name: String): Path

Creates a Path for a sibling file or directory with the specified name.

success

fun success(): Outcome.Success<Boolean>

Creates a Success with a true value.

fun <T> success(value: T): Outcome.Success<T>

Creates a Success with the specified value.

inline suspend fun <T> success(block: suspend () -> T): Outcome.Success<T>

Executes the block and wraps the result in a Success.

toOutcome

fun <T> Result<T>.toOutcome(): Outcome<T>

Converts this Result to an Outcome.