Enum budvm::Value

pub enum Value {
    Void,
    Integer(i64),
    Real(f64),
    Boolean(bool),
    Dynamic(Dynamic),
}

A virtual machine value.

Variants

Void

A value representing the lack of a value.

Integer(i64)

A signed 64-bit integer value.

Real(f64)

A real number value (64-bit floating point).

Boolean(bool)

A boolean representing true or false.

Dynamic(Dynamic)

A type exposed from Rust.

Implementations

impl Value

pub fn dynamic(value: impl DynamicValue + 'static) -> Self

Returns a new value containing the Rust value provided.

pub fn as_dynamic<T: DynamicValue>(&self) -> Option<&T>

Returns a reference to the contained value, if it was one originally created with Value::dynamic(). If the value isn’t a dynamic value or T is not the correct type, None will be returned.

pub fn try_into_dynamic<T: DynamicValue>(self) -> Result<T, Self>

Returns the contained value if T matches the contained type and this is the final reference to the value. If the value contains another type or additional references exist, Err(self) will be returned. Otherwise, the original value will be returned.

pub fn into_dynamic<T: DynamicValue + Clone>(self) -> Result<T, Self>

Returns the contained value, if it was one originally created with Value::dynamic() and T is the same type. If the value contains another type, Err(self) will be returned. Otherwise, the original value will be returned.

Because dynamic values are cheaply cloned by wrapping the value in an std::sync::Arc, this method will return a clone if there are any other instances that point to the same contained value. If this is the final instance of this value, the contained value will be returned without additional allocations.

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

If this value is a Value::Integer, this function returns the contained value. Otherwise, None is returned.

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

If this value is a Value::Real, this function returns the contained value. Otherwise, None is returned.

pub fn convert<Env>( &self, kind: &ValueKind, environment: &Env ) -> Result<Self, FaultKind>where Env: Environment,

Converts this value to another kind, if possible.

pub fn try_convert_to_string<Env>(&self, env: &Env) -> Result<String, FaultKind>where Env: Environment<String = String>,

Tries to convert this value into a String.

This is a shorthand for calling convert() and then into_dynamic() on the resulting value.

pub fn is_truthy(&self) -> bool

Returns true if the value is considered truthy.

value type	condition
Integer	value != 0
Boolean	value is true
Void	always false

pub fn is_falsey(&self) -> bool

Returns the inverse of is_truthy()

pub fn kind(&self) -> ValueKind

Returns the kind of the contained value.

pub fn implements_hash(&self) -> bool

Returns true if value contained supports hashing.

Using Hash on a value that does not support hashing will not panic, but unique hash values will not be generated.

pub fn try_hash<H: Hasher>(&self, state: &mut H) -> bool

Attempts to compute a hash over this value. Returns true if the value contained supports hashing.

The state may be mutated even if the contained value does not contain a hashable value.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl Display for Value

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Value

fn from(str: &'a str) -> Self

Converts to this type from the input type.

impl From<()> for Value

fn from(_: ()) -> Self

Converts to this type from the input type.

impl<T> From<T> for Valuewhere T: DynamicValue,

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(real: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(int: i64) -> Self

Converts to this type from the input type.

impl FromIterator<Value> for List

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStack for Value

fn from_value(value: Value) -> Result<Self, FaultKind>

Returns an instance constructing from the stack.

impl Hash for Value

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Value> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<bool> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<f64> for Value

fn eq(&self, rhs: &f64) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<i64> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Value> for Value

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Value