Enum RuntimeValue 

pub enum RuntimeValue {
    Number(Number),
    Boolean(bool),
    String(String),
    Symbol(Ident),
    Array(Vec<RuntimeValue>),
    Markdown(Node, Option<Selector>),
    Function(AstParams, Program, Shared<SharedCell<Env>>),
    NativeFunction(Ident),
    Dict(BTreeMap<Ident, RuntimeValue>),
    Module(ModuleEnv),
    Ast(Shared<Node>),
    None,
}

A value in the mq runtime.

This enum represents all possible value types that can exist during program execution, including numbers, strings, markdown nodes, functions, and more complex data structures.

Variants

Number(Number)

A numeric value.

Boolean(bool)

A boolean value (true or false).

String(String)

A string value.

Symbol(Ident)

A symbol (interned identifier).

Array(Vec<RuntimeValue>)

An array of runtime values.

Markdown(Node, Option<Selector>)

A markdown node with an optional selector for indexing.

Function(AstParams, Program, Shared<SharedCell<Env>>)

A user-defined function with parameters, body (program), and captured environment.

NativeFunction(Ident)

A built-in native function identified by name.

Dict(BTreeMap<Ident, RuntimeValue>)

A dictionary mapping identifiers to runtime values.

Module(ModuleEnv)

A module with its exports.

Ast(Shared<Node>)

An AST node (quoted expression).

None

An empty or null value.

Implementations

impl RuntimeValue

pub const EMPTY_ARRAY: RuntimeValue

An empty array constant.

pub const FALSE: RuntimeValue

The boolean false value.

pub const NONE: RuntimeValue = Self::None

The None (null) value.

pub const TRUE: RuntimeValue

The boolean true value.

pub fn new_dict() -> RuntimeValue

Creates a new empty dictionary.

pub fn name(&self) -> &str

Returns the type name of this runtime value as a string.

pub fn is_none(&self) -> bool

Returns true if this value is None.

pub fn is_function(&self) -> bool

Returns true if this value is a user-defined function.

pub fn is_native_function(&self) -> bool

Returns true if this value is a native (built-in) function.

pub fn is_array(&self) -> bool

Returns true if this value is an array.

pub fn is_empty(&self) -> bool

Returns true if this value is considered empty.

Empty values include empty arrays, empty strings, empty markdown nodes, empty dictionaries, and None.

pub fn is_truthy(&self) -> bool

Returns true if this value is considered truthy in conditional contexts.

Truthy values include non-zero numbers, non-empty strings and arrays, true, functions, symbols, and modules. Falsy values include false, zero, empty collections, and None.

pub fn len(&self) -> usize

Returns the length of this value.

For numbers, returns the value as usize. For strings and arrays, returns the number of elements. For dictionaries, returns the number of entries.

pub fn markdown_node(&self) -> Option<Node>

Extracts the markdown node from this value, if it is a markdown value.

If a selector is present, returns the selected child node.

pub fn update_markdown_value(&self, value: &str) -> RuntimeValue

Updates the value of a markdown node, returning a new runtime value.

If this is not a markdown value, returns None.

pub fn position(&self) -> Option<Position>

Returns the position information for a markdown node, if available.

pub fn set_position(&mut self, position: Option<Position>)

Sets the position information for a markdown node.

Only affects markdown values; other value types are unaffected.

Trait Implementations

impl Clone for RuntimeValue

fn clone(&self) -> RuntimeValue

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuntimeValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for RuntimeValue

fn default() -> RuntimeValue

Returns the “default value” for a type.

impl Display for RuntimeValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&mut str> for RuntimeValue

fn from(s: &mut str) -> Self

Converts to this type from the input type.

impl From<&str> for RuntimeValue

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<AttrValue> for RuntimeValue

fn from(attr_value: AttrValue) -> Self

Converts to this type from the input type.

impl From<BTreeMap<Ident, RuntimeValue>> for RuntimeValue

fn from(map: BTreeMap<Ident, RuntimeValue>) -> Self

Converts to this type from the input type.

impl From<Ident> for RuntimeValue

fn from(i: Ident) -> Self

Converts to this type from the input type.

impl From<Node> for RuntimeValue

fn from(node: Node) -> Self

Converts to this type from the input type.

impl From<String> for RuntimeValue

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Value> for RuntimeValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Vec<(String, Number)>> for RuntimeValue

fn from(v: Vec<(String, Number)>) -> Self

Converts to this type from the input type.

impl From<Vec<RuntimeValue>> for RuntimeValue

fn from(arr: Vec<RuntimeValue>) -> Self

Converts to this type from the input type.

impl From<bool> for RuntimeValue

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<usize> for RuntimeValue

fn from(n: usize) -> Self

Converts to this type from the input type.

impl PartialEq for RuntimeValue

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RuntimeValue

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.