cosmic-binary-format/xyz.xenondevs.cbf

Package-level declarations

Types

Cbf

object Cbf

CbfSecurityException

class CbfSecurityException : RuntimeException

An exception that is thrown when an action is prevented by the CbfSecurityManager.

CbfSecurityManager

interface CbfSecurityManager

The security manager is responsible for controlling the creation of serializers.

Compound

class Compound

A compound is a key-value storage intended for serialization via Cbf.

UncheckedApi

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class UncheckedApi

Requires opt-in: This function cannot check whether the KType is correct, i.e. whether it matches the generic type of the function. Before using a function annotated with this annotation, consider using a type-inferring inline function instead, if possible.

Functions

entry

@JvmName(name = "entry1")

inline fun <T : Any> Provider<Compound?>.entry(key: String, noinline defaultValue: () -> T? = { null }): MutableProvider<T?>

Creates a MutableProvider of type T that is linked to the value under key of this provider's Compound. If the compound does not have an entry under key, defaultValue is used to create it lazily. If there is already an entry provider for key that matches T, defaultValue will be ignored and the existing provider will be returned.

@JvmName(name = "entry0")

inline fun <T : Any> Provider<Compound>.entry(key: String, noinline defaultValue: () -> T): MutableProvider<T>

Creates a MutableProvider of non-null type T that is linked to the value under key of this provider's Compound. If the compound does not have an entry under key, defaultValue is used to create it lazily. If there is already an entry provider for key that matches T, defaultValue will be ignored and the existing provider will be returned.