ActionContext

Struct ActionContext 

Source
pub struct ActionContext {
    pub objects: HashMap<String, Object>,
    pub parameters: HashMap<String, Value>,
    pub metadata: HashMap<String, String>,
}
Expand description

Context passed to actions containing relevant objects and traits

Fields§

§objects: HashMap<String, Object>

Objects relevant to this action

§parameters: HashMap<String, Value>

Additional parameters for the action

§metadata: HashMap<String, String>

Metadata about the action execution

Implementations§

Source§

impl ActionContext

Source

pub fn new() -> Self

Create a new action context

Source

pub fn with_capacity( expected_objects: usize, expected_parameters: usize, ) -> Self

Create a new action context with expected capacity

Source

pub fn add_object(&mut self, name: impl Into<String>, object: Object)

Add an object to the context

Source

pub fn get_object(&self, name: &str) -> Option<&Object>

Get an object from the context

Source

pub fn get_objects(&self, names: &[&str]) -> HashMap<String, &Object>

Get multiple objects efficiently

Source

pub fn add_parameter(&mut self, name: impl Into<String>, value: Value)

Add a parameter to the context

Source

pub fn get_parameter(&self, name: &str) -> Option<&Value>

Get a parameter from the context

Source

pub fn add_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Add metadata to the context

Source

pub fn get_metadata(&self, key: &str) -> Option<&String>

Get metadata from the context

Source

pub fn object_count(&self) -> usize

Get object count

Source

pub fn parameter_count(&self) -> usize

Get parameter count

Source

pub fn metadata_count(&self) -> usize

Get metadata count

Source

pub fn reserve_objects(&mut self, additional: usize)

Reserve capacity for objects

Source

pub fn reserve_parameters(&mut self, additional: usize)

Reserve capacity for parameters

Source

pub fn clear_objects(&mut self)

Clear all objects

Source

pub fn clear_parameters(&mut self)

Clear all parameters

Source

pub fn clear_metadata(&mut self)

Clear all metadata

Trait Implementations§

Source§

impl Clone for ActionContext

Source§

fn clone(&self) -> ActionContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ActionContext

Source§

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

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

impl Default for ActionContext

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