Struct Node

pub struct Node<S: Stage> { /* private fields */ }

Every node wraps a Stage, which is a decorated function that has some number of inputs and some number of outputs.

TODO: Explain the caching functionality in detail

Implementations

impl<S: Stage> Node<S>

pub fn new(stage: S, initial_state: S::State) -> Self

Trait Implementations

impl<S: Stage + 'static> AnyNode for Node<S>

fn into_any(self: Box<Self>) -> Box<dyn Any>

Upcast to dyn Any to get its more-specific downcast capabilities

fn as_any(&self) -> &dyn Any

Primarily used for internal checks

fn as_any_mut(&mut self) -> &mut dyn Any

USed to get mutable access to state

fn eval_strategy(&self) -> EvalStrategy

fn reeval_rule(&self) -> ReevaluationRule

fn replace_output( &mut self, key: &DataLabel, output: Arc<dyn Any + Send + Sync>, ) -> Result<Option<Arc<dyn Any + Send + Sync>>, InjectionError>

Set the outputs and return any existing outputs.

fn eval( &mut self, ) -> Result<HashMap<DataLabel, Arc<dyn Any + Send + Sync>>, InjectionError>

Evaluates the node. Returns a map of prior outputs

fn flow_data( &mut self, parent: &mut Box<dyn AnyNode>, output: DataLabel, input: DataLabel, ) -> Result<(), InjectionError>

This a a core part of the plumbing of this crate - take the outputs of a parent node and use them to set the inputs of a child node.

fn inputs_mut( &mut self, ) -> &mut HashMap<DataLabel, (Arc<dyn Any + Send + Sync>, ReevaluationRule)>

Used to support [Self::flow_data]

fn outputs_mut(&mut self) -> &mut HashMap<DataLabel, Arc<dyn Any + Send + Sync>>

Used to support [Self::flow_data]

fn set_input_changed(&mut self, val: bool)

Used to indicate that an input has been modified from a previous run.

fn input_changed(&self) -> bool

See [Self::set_input_changed]

fn input_reftype(&self, name: &DataLabel) -> Option<RefType>

Look of the reftype of a particular input

fn input_names(&self) -> Cloned<Keys<'_, DataLabel, (TypeId, RefType)>>

fn output_names(&self) -> Cloned<Keys<'_, DataLabel, TypeId>>

fn stage_name(&self) -> &str

impl<S: Debug + Stage> Debug for Node<S>

where S::State: Debug,

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

Formats the value using the given formatter.