Struct abscissa_core::component::Registry

pub struct Registry<A: Application + 'static> { /* fields omitted */ }

The component registry provides a system for runtime registration of application components which can interact with each other dynamically.

Components are sorted according to a dependency ordering, started in-order, and at application termination time, shut down in reverse order.

Methods

impl<A> Registry<A> where
    A: Application + 'static, 

pub fn register<I>(&mut self, components: I) -> Result<(), FrameworkError> where
    I: IntoIterator<Item = Box<dyn Component<A>>>, 

Register components, determining their dependency order

pub fn after_config(&mut self, config: &A::Cfg) -> Result<(), FrameworkError>

Callback fired by application when configuration has been loaded

pub fn len(&self) -> usize

Get the number of currently registered components

pub fn is_empty(&self) -> bool

Is the registry empty?

pub fn get(&self, handle: Handle) -> Option<&dyn Component<A>>

Get a component reference by its handle

pub fn get_mut(
    &mut self,
    handle: Handle
) -> Option<&mut (dyn Component<A> + 'static)>

Get a mutable component reference by its handle

pub fn get_handle_by_id(&self, id: Id) -> Option<Handle>

Get a component's handle by its ID

pub fn get_handle(&self, component: &dyn Component<A>) -> Option<Handle>

Get the handle for the given component, if it's registered

pub fn get_by_id(&self, id: Id) -> Option<&dyn Component<A>>

Get a component ref by its ID

pub fn get_mut_by_id(
    &mut self,
    id: Id
) -> Option<&mut (dyn Component<A> + 'static)>

Get a mutable component ref by its ID

pub fn iter(&self) -> Iter<A>

Iterate over the components.

pub fn iter_mut(&mut self) -> IterMut<A>

Iterate over the components mutably.

pub fn shutdown(
    &self,
    app: &A,
    shutdown: Shutdown
) -> Result<(), FrameworkError>

Shutdown components (in the reverse order they were started)

pub fn get_downcast_ref<C>(&self) -> Option<&C> where
    C: Component<A>, 

Get a component reference by its type

pub fn get_downcast_mut<C>(&mut self) -> Option<&mut C> where
    C: Component<A>, 

Get a mutable component reference by its type

Trait Implementations

impl<A: Debug + Application + 'static> Debug for Registry<A>

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

Formats the value using the given formatter.

impl<A> Default for Registry<A> where
    A: Application + 'static, 

fn default() -> Self

Returns the "default value" for a type.