Struct dust_lib::VariableMap

pub struct VariableMap { /* private fields */ }

A collection dust variables comprised of key-value pairs.

The inner value is a BTreeMap in order to allow VariableMap instances to be sorted and compared to one another.

Implementations

impl VariableMap

pub fn new() -> Self

Creates a new instace.

pub fn call_function(&self, identifier: &str, argument: &Value) -> Result<Value>

Invokes built-in tools or user-defined functions based on the identifier and passes the
argument. Returns an error a tool is called with the wrong inputs or if the identifier does not match any tools or functions.

pub fn get_value(&self, identifier: &str) -> Result<Option<Value>>

Returns a Value assigned to the identifer, allowing dot notation to retrieve Values that are /// nested in Lists or Maps. Returns None if there is no variable with a key matching the /// identifier. Returns an error if a Map or List is indexed incorrectly.

pub fn set_value(&mut self, identifier: &str, value: Value) -> Result<()>

Assigns a variable with a Value and the identifier as its key, allowing dot notation to assign nested lists and maps. Returns an error if a List or Map is indexed incorrectly.

pub fn inner(&self) -> &BTreeMap<String, Value>

Returns a reference to the inner BTreeMap.

pub fn len(&self) -> usize

Returns the number of stored variables.

pub fn is_empty(&self) -> bool

Returns true if the length is zero.

Trait Implementations

impl Clone for VariableMap

fn clone(&self) -> VariableMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariableMap

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

Formats the value using the given formatter.

impl Default for VariableMap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VariableMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VariableMap

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

Formats the value using the given formatter.

impl From<&Table> for VariableMap

fn from(value: &Table) -> Self

Converts to this type from the input type.

impl From<&VariableMap> for Table

fn from(map: &VariableMap) -> Self

Converts to this type from the input type.

impl From<&mut VariableMap> for Table

fn from(map: &mut VariableMap) -> Self

Converts to this type from the input type.

impl From<VariableMap> for Table

fn from(map: VariableMap) -> Self

Converts to this type from the input type.

impl Ord for VariableMap

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<VariableMap> for VariableMap

fn eq(&self, other: &VariableMap) -> 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<VariableMap> for VariableMap

fn partial_cmp(&self, other: &VariableMap) -> 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 Serialize for VariableMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VariableMap

impl StructuralEq for VariableMap

impl StructuralPartialEq for VariableMap