Skip to main content

Value

Enum Value 

Source
pub enum Value {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    String(Box<str>),
    Tensor(Box<Tensor>),
    Reference(Reference),
    Expression(Box<Expression>),
    List(Box<Vec<Value>>),
}
Expand description

Re-export core types for convenience. A scalar value in HEDL.

Optimized memory layout:

  • Large variants (String, Tensor, Expression, List) are boxed to keep enum size small
  • Small values (Null, Bool, Int, Float) remain inline
  • Total enum size: 16 bytes (down from 32+ bytes)
  • Reduces memory usage by 40-50% for typical documents

Variants§

§

Null

Null value (~).

§

Bool(bool)

Boolean value (true/false).

§

Int(i64)

Integer value.

§

Float(f64)

Floating-point value.

§

String(Box<str>)

String value (boxed to reduce enum size).

§

Tensor(Box<Tensor>)

Tensor (multi-dimensional array, boxed to reduce enum size).

§

Reference(Reference)

Reference to another node.

§

Expression(Box<Expression>)

Parsed expression from $(…) (boxed to reduce enum size).

§

List(Box<Vec<Value>>)

List of scalar values (from (...) syntax).

Distinct from Tensor: lists can contain any scalar types (strings, bools, refs, etc.), while tensors are numeric-only.

§Examples

use hedl_core::Value;

// String list: (admin, editor, viewer)
let roles = Value::List(Box::new(vec![
    Value::String("admin".into()),
    Value::String("editor".into()),
    Value::String("viewer".into()),
]));

// Bool list: (true, false, true)
let flags = Value::List(Box::new(vec![
    Value::Bool(true),
    Value::Bool(false),
    Value::Bool(true),
]));

// Empty list: ()
let empty = Value::List(Box::new(vec![]));

Implementations§

Source§

impl Value

Source

pub fn is_null(&self) -> bool

Returns true if this value is null.

Source

pub fn is_reference(&self) -> bool

Returns true if this value is a reference.

Source

pub fn is_list(&self) -> bool

Returns true if this value is a list.

Source

pub fn as_list(&self) -> Option<&[Value]>

Try to get the value as a list.

Source

pub fn as_str(&self) -> Option<&str>

Try to get the value as a string.

Source

pub fn as_int(&self) -> Option<i64>

Try to get the value as an integer.

Source

pub fn as_float(&self) -> Option<f64>

Try to get the value as a float.

Source

pub fn as_bool(&self) -> Option<bool>

Try to get the value as a boolean.

Source

pub fn as_reference(&self) -> Option<&Reference>

Try to get the value as a reference.

Source§

impl Value

Source

pub fn as_expression(&self) -> Option<&Expression>

Try to get the expression if this is an Expression variant.

Source

pub fn coerce_to(&self, expected: &ExpectedType) -> CoercionResult

Attempt to coerce this value to the expected type.

Uses lenient mode (equivalent to Standard level) by default.

§Examples
use hedl_core::Value;
use hedl_core::types::ExpectedType;

let value = Value::String("42".to_string().into());
let result = value.coerce_to(&ExpectedType::Int);
assert!(result.is_ok());
Source

pub fn can_coerce_to(&self, expected: &ExpectedType) -> bool

Check if this value can be coerced to the expected type.

Returns true if coercion would succeed (either matched or coerced).

§Examples
use hedl_core::Value;
use hedl_core::types::ExpectedType;

let value = Value::Int(42);
assert!(value.can_coerce_to(&ExpectedType::Float));

let value = Value::String("42".to_string().into());
assert!(value.can_coerce_to(&ExpectedType::Int));

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Value

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for Value

Auto Trait Implementations§

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnwindSafe for Value

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.