quarkdown-core/com.quarkdown.core.function.value

Package-level declarations

Types

interface AdaptableValue<T : InputValue<*>>

If a Value subclass is adaptable, it can be converted to another Value in case the parameter of the function it is passed to expects a different type.

BooleanValue

data class BooleanValue(val unwrappedValue: Boolean) : InputValue<Boolean> , OutputValue<Boolean>

An immutable boolean Value.

Destructurable

interface Destructurable<T : Value<*>>

Anything that can be destructured into a sequence of Value components.

DictionaryValue

data class DictionaryValue<T : OutputValue<*>>(val unwrappedValue: MutableMap<String, T>) : InputValue<MutableMap<String, T>> , OutputValue<MutableMap<String, T>> , AdaptableValue<IterableValue<PairValue<StringValue, T>>>

A mutable Map, with string keys and values of type T. A dictionary can be adapted to an iterable list of key-value entries.

DynamicValue

data class DynamicValue(val unwrappedValue: Any?) : InputValue<Any?> , OutputValue<Any?>

A Value whose type has not been yet determined.

EnumValue

data class EnumValue(val unwrappedValue: Enum<*>) : InputValue<Enum<*>>

A Value that wraps an element from a static enum class.

GeneralCollectionValue

data class GeneralCollectionValue<T : OutputValue<*>>(val unwrappedValue: Iterable<T>) : IterableValue<T>

An immutable Value that contains other values of the same type. The kind of ordering is not relevant. When exporting to a node via com.quarkdown.core.function.value.output.node.NodeOutputValueVisitor, this collection is simply converted to a group of nodes.

InlineMarkdownContentValue

data class InlineMarkdownContentValue(val unwrappedValue: InlineMarkdownContent) : InputValue<InlineMarkdownContent>

A sub-AST that contains Markdown nodes. This is usually accepted in 'body' parameters.

InputValue

sealed interface InputValue<T> : Value<T> , Expression

An immutable value wrapper that is used in function parameters and function call arguments. When used as an Expression, its evaluated value is the same as its static wrapped value

IterableValue

interface IterableValue<T : OutputValue<*>> : InputValue<Iterable<T>> , OutputValue<Iterable<T>> , Destructurable<T> , Iterable<T>

A Value that wraps an Iterable collection of Value elements.

LambdaValue

data class LambdaValue(val unwrappedValue: Lambda) : InputValue<Lambda>

A Value that wraps an action of variable parameter count.

MarkdownContentValue

data class MarkdownContentValue(val unwrappedValue: MarkdownContent) : InputValue<MarkdownContent>

A sub-AST that contains Markdown nodes. This is usually accepted in 'body' parameters.

NodeValue

data class NodeValue(val unwrappedValue: Node) : OutputValue<Node> , Expression

An immutable Node.

None

data object None

Nothing. This is Quarkdown's equivalent of null.

NoneValue

data object NoneValue : InputValue<None> , OutputValue<None>

A value that represents a missing value.

NumberValue

data class NumberValue(rawUnwrappedValue: Number) : InputValue<Number> , OutputValue<Number>

An immutable numeric Value.

ObjectValue

data class ObjectValue<T>(val unwrappedValue: T) : InputValue<T> , OutputValue<T>

A Value that wraps an element from a static enum class.

OrderedCollectionValue

data class OrderedCollectionValue<T : OutputValue<*>>(val unwrappedValue: List<T>) : IterableValue<T>

An immutable Value that contains other values of the same type, ordered.

OutputValue

sealed interface OutputValue<T> : Value<T>

An immutable value wrapper that is used in function outputs.

PairValue

data class PairValue<F : OutputValue<*>, S : OutputValue<*>>(pairUnwrappedValue: Pair<F, S>) : IterableValue<OutputValue<*>>

An immutable Value that contains two elements, which can be iterated. When a DictionaryValue is iterated, it's equivalent to a list of key-value pairs.

StringValue