Skip to main content

VariablePool

Struct VariablePool 

Source
pub struct VariablePool { /* private fields */ }
Expand description

Variable storage for one execution frame.

Implementations§

Source§

impl VariablePool

Source

pub fn new() -> Self

Source

pub fn get(&self, selector: &Selector) -> Option<Value>

Resolve a selector, descending into nested values. Missing values return None.

Source

pub fn get_or_null(&self, selector: &Selector) -> Value

Resolve a selector, returning Value::Null when absent.

Source

pub fn set(&mut self, selector: &Selector, value: Value)

Set namespace.name. Any path in the selector is ignored; use VariablePool::set_path for nested writes.

Source

pub fn insert(&mut self, namespace: &str, name: &str, value: Value)

Set a variable by namespace and name.

Source

pub fn set_path( &mut self, selector: &Selector, value: Value, ) -> Result<(), PathError>

Write into a nested path, creating intermediate objects as needed. Array elements are addressed by index; writing past the end of an array is an error (nothing is written).

Source

pub fn remove(&mut self, selector: &Selector) -> Option<Value>

Remove one variable.

Source

pub fn remove_namespace(&mut self, namespace: &str)

Drop a whole namespace (e.g. a node’s outputs before a loop round re-runs it).

Source

pub fn set_outputs( &mut self, namespace: &str, outputs: &IndexMap<String, Value>, )

Bulk-insert a node’s outputs.

Source

pub fn namespace(&self, namespace: &str) -> Option<&IndexMap<Arc<str>, Value>>

All variables in a namespace.

Source

pub fn contains(&self, selector: &Selector) -> bool

Source

pub fn iter(&self) -> impl Iterator<Item = (&str, &str, &Value)>

Iterate (namespace, name, value).

Source

pub fn to_snapshot(&self) -> PoolSnapshot

Serializable form for snapshots. The ENV namespace is excluded: the host must supply environment variables again on resume. Secrets in other namespaces are stored as {"$secret": "redacted"} markers and restored as redacted secrets (see Value::redacted_secret).

Source

pub fn from_snapshot(snapshot: PoolSnapshot) -> Self

Restore from a snapshot (env variables must be re-applied by the caller).

Source

pub fn insert_typed( &mut self, namespace: &str, name: &str, ty: ValueType, value: Value, ) -> Result<(), TypeMismatch>

Insert a typed declared variable, validating it against its declared type.

Trait Implementations§

Source§

impl Clone for VariablePool

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VariablePool

Source§

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

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

impl Default for VariablePool

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.