Struct Value

pub struct Value<T = Type, B = EcoVec<u8>> { /* private fields */ }

A Lustre value with its type, stored as a compact opaque value

Usage

• Use Value::type_of() to get the type of the value
• Use Value::unpack() to inspect the contents of the value

Internal representation

Values are usually stored as a tuple of Type × EcoVec<u8>*. The interpretation of the byte array is directly dependent on the type of the value. The implementation may use unsafe code that assumes that the byte array has the correct length for a given type.

^{*The type is generic over both of these, so you can have a borrowed version of a value}

A given type always has a constant size that may be 0. The types respect the following encoding:

• bools are encoded as 0 or 1, as a single byte
• ints are encoded as i32 in native endianness
• reals are encoded as f32 in native endianness
• Arrays are encoded as a continuous concatenation of its element’s encodings
• Tuples are encoded the same way, but may obviously be heterogeneous

Implementations

impl<T: Borrow<Type>, B> Value<T, B>

pub fn type_of(&self) -> &Type

impl<T: Borrow<Type>, B: AsRef<[u8]>> Value<T, B>

pub fn unpack(&self) -> UValue<'_>

pub fn as_ref(&self) -> Value<&Type, &[u8]>

pub fn to_owned(&self) -> Value

impl Value

pub fn from_bool(value: bool) -> Self

pub fn from_int(value: i32) -> Self

pub fn from_real(value: N32) -> Self

pub fn repeat(self, n: usize) -> Self

Create an array of n repeating elements of value self

Trait Implementations

impl<T: Clone, B: Clone> Clone for Value<T, B>

fn clone(&self) -> Value<T, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Borrow<Type>, B: AsRef<[u8]>> Debug for Value<T, B>

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

Formats the value using the given formatter.

impl From<Value> for StaticArg

fn from(value: Value) -> Self

Converts to this type from the input type.

impl<T: Borrow<Type>, B: AsRef<[u8]>> Hash for Value<T, B>

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<T: Borrow<Type>, B: AsRef<[u8]>> Ord for Value<T, B>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: Borrow<Type>, B: AsRef<[u8]>> PartialEq for Value<T, B>

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<T: Borrow<Type>, B: AsRef<[u8]>> PartialOrd for Value<T, B>

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.

impl<T: Borrow<Type>, B: AsRef<[u8]>> Eq for Value<T, B>