Struct interact::Root

pub struct Root<'a, 'b> {
    pub send: Option<&'a mut RootSend>,
    pub local: Option<&'b mut RootLocal>,
}

A temporary binder of RootSend and RootLocal dictionaries, used for providing a unified dictionary to the user.

Fields

send: Option<&'a mut RootSend>

local: Option<&'b mut RootLocal>

Methods

impl<'a, 'b> Root<'a, 'b>

pub fn probe(
    &mut self,
    path_str: &str
) -> (Result<NodeTree, ClimbError>, Assist<String>)

Probe a path, checking if it is valid. If it contains a function name, it will not be called. If it contains an assignment, the assignment will not take place but the parameters value will check for Deser deserialization.

This call may block the current thread until ReflectIndirect evaluation is resolved, and it may block because some fields, depending on the types and usage, could be behind a Mutex lock.

pub fn access(
    &mut self,
    path_str: &str
) -> (Result<NodeTree, ClimbError>, Assist<String>)

Perform evaluation of the provided path. This may perform assignments, or call user-defined functions via the #[interact(...)] type attribute.

This call may block the current thread until ReflectIndirect evaluation is resolved, and it may block because some fields, depending on the types and usage, could be behind a Mutex lock.

pub fn keys(&self) -> Vec<&'static str>