Struct Registry

pub struct Registry(/* private fields */);

A Registry stores each node, its state, and the logical Stage associated with it.

Implementations

impl Registry

pub fn new() -> Self

pub fn state<S: Stage + 'static>( &self, id: usize, ) -> Result<&S::State, RegistryError>

Get a reference to the state of a specific node.

pub fn state_mut<S: Stage + 'static>( &mut self, id: usize, ) -> Result<&mut S::State, RegistryError>

Get a mutable reference to the state of a specific node.

pub fn register<S: Stage + 'static>(&mut self, stage: S) -> usize

where S::State: Default,

Add a node to the registry. This returns a unique identifier for that node, which can be used to add it to a crate::Graph. This uses default state

pub fn register_with_state<S: Stage + 'static>( &mut self, stage: S, state: S::State, ) -> usize

Add a node to the registry. This returns a unique identifier for that node, which can be used to add it to a crate::Graph

pub fn validate_node_type<S: Stage + 'static>( &self, id: usize, ) -> Result<(), RegistryError>

Returns an error if the registry doesn’t contain a node with a stage of the specified type with the given id.

pub fn unregister<S: Stage + 'static>( &mut self, id: usize, ) -> Result<Option<Node<S>>, RegistryError>

Remove a node from the registry and return it. This will return an error if S doesn’t match the stage type for that node.

pub fn unregister_and_drop(&mut self, id: usize) -> Result<(), RegistryError>

Remove a node from the registry and drop it.

pub fn get(&self, id: usize) -> Option<&Box<dyn AnyNode>>

Get a type-erased node

pub fn get_mut(&mut self, id: usize) -> Option<&mut Box<dyn AnyNode>>

Get a mutable type-erased node

pub fn get2_mut( &mut self, id0: usize, id1: usize, ) -> Result<(&mut Box<dyn AnyNode>, &mut Box<dyn AnyNode>), NodesNotFoundError>

Get 2 mutable type-erased nodes

This is an important internal detail: a parent a child node often need to be modified together.

This function will panic if id0 and id1 are the same.

impl Registry

pub fn get_node_by_id(&self, id: usize) -> Option<&dyn AnyNode>

Gets a node by its ID.