Struct abscissa_core::component::Registry

pub struct Registry<A: Application> { /* 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, 

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 iter(&mut self) -> Iter<Box<dyn Component<A>>>

Iterate over the components mutably.

pub fn iter_mut(&mut self) -> IterMut<Box<dyn Component<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)

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

pub fn get_ref<C>(&self) -> Option<&C> where
    C: Component<A> + 'static, 

Get a reference to a component of the given type, if one has been registered

pub fn get_mut<C>(&mut self) -> Option<&mut C> where
    C: Component<A> + 'static, 

Get a mutable reference component of the given type, if one has been registered

Trait Implementations

impl<A> Default for Registry<A> where
    A: Application, 

fn default() -> Self

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.