Enum Value

#[non_exhaustive]
pub enum Value<'a, T> {
    Prim(T),
    Bool(bool),
    Function(Function<'a, T>),
    Tuple(Vec<Value<'a, T>>),
    Object(HashMap<String, Value<'a, T>>),
    Ref(OpaqueRef),
}

Values produced by expressions during their interpretation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Prim(T)

Primitive value, such as a number. This does not include Boolean values, which are a separate variant.

Literals must necessarily map to primitive values, but there may be some primitive values not representable as literals.

Bool(bool)

Boolean value.

Function(Function<'a, T>)

Function.

Tuple(Vec<Value<'a, T>>)

Tuple of zero or more values.

Object(HashMap<String, Value<'a, T>>)

Object with zero or more named fields.

Ref(OpaqueRef)

Opaque reference to a native value.

Implementations

impl<'a, T> Value<'a, T>

pub fn native_fn(function: impl NativeFn<T> + 'static) -> Self

Creates a value for a native function.

pub fn wrapped_fn<Args, F>(fn_to_wrap: F) -> Self

where FnWrapper<Args, F>: NativeFn<T> + 'static,

Creates a wrapped function.

Calling this method is equivalent to wrapping a function and calling Self::native_fn() on it. Thanks to type inference magic, the Rust compiler will usually be able to extract the Args type param from the function definition, provided that type of function arguments and its return type are defined explicitly or can be unequivocally inferred from the declaration.

pub fn void() -> Self

Creates a void value (an empty tuple).

pub fn opaque_ref(value: impl Any + Debug + PartialEq) -> Self

Creates a reference to a native variable.

pub fn value_type(&self) -> ValueType

Returns the type of this value.

pub fn is_void(&self) -> bool

Checks if this value is void (an empty tuple).

pub fn is_function(&self) -> bool

Checks if this value is a function.

Trait Implementations

impl<T: Clone> Clone for Value<'_, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Value<'a, T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Value<'_, T>

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

Formats the value using the given formatter.

impl<'a, T: Clone> From<&Value<'a, T>> for Value<'a, T>

fn from(reference: &Value<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> IntoEvalResult<'a, T> for Value<'a, T>

fn into_eval_result(self) -> Result<Value<'a, T>, ErrorOutput<'a>>

Performs the conversion.

impl<T: PartialEq> PartialEq for Value<'_, T>

fn eq(&self, rhs: &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<T: 'static + Clone> StripCode for Value<'_, T>

type Stripped = Value<'static, T>

Resulting type after code stripping.

fn strip_code(self) -> Self::Stripped

Strips references to code fragments in this type.

impl<'a, T> TryFromValue<'a, T> for Value<'a, T>

fn try_from_value(value: Value<'a, T>) -> Result<Self, FromValueError>

Attempts to convert value to a type supported by the function.