Skip to main content

Variables

Struct Variables 

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

The mutable variable bag for one flow run.

Implementations§

Source§

impl Variables

Source

pub fn new() -> Self

An empty state ({}).

Source

pub fn from_value(value: Value) -> Self

Wrap an existing JSON object as state. A non-object is replaced by {}.

Source

pub fn seed_from_inputs( inputs: &BTreeMap<String, InputSpec>, args: &Value, ) -> (Self, Vec<String>)

Seed state from an entry node’s declared inputs and the caller-supplied argument object. Required inputs missing from args and lacking a default are reported by name (so the caller can reject the invocation); present values and defaults are written, and _inputs is set to the seeded map.

Source

pub fn as_value(&self) -> &Value

Borrow the underlying JSON object.

Source

pub fn into_value(self) -> Value

Consume and return the underlying JSON object.

Source

pub fn get(&self, path: &str) -> Option<&Value>

Look up a dotted path within the state.

Source

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

Set a top-level variable. (Nested assignment uses Self::set_path.)

Source

pub fn set_last(&mut self, value: Value)

Set the reserved _last edge payload (the next node’s input).

Source

pub fn set_path(&mut self, path: &str, value: Value)

Set a value at a dotted path, creating intermediate objects as needed. A leading/empty segment is ignored; an empty path is a no-op.

Trait Implementations§

Source§

impl Clone for Variables

Source§

fn clone(&self) -> Variables

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 Variables

Source§

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

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

impl Default for Variables

Source§

fn default() -> Variables

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

impl PartialEq for Variables

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Variables

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.