Interface Component

node/src/components.rs:125–149

Core Component. Every component process a set of events it defines itself Its inputs are `Event`s, allowing it to perform work whenever an event is received, outputting `Effect`s each time it is called. # Error and halting states Components in general are expected to be able to handle every input (`Event`) in every state. Invalid inputs are supposed to be discarded, and the machine is expected

/// Components place restrictions on reactor events (`REv`s), indicating what kind of effects they
/// need to be able to produce to operate.
pub(crate) trait Component<REv> {
    /// Event associated with `Component`.
    ///
    /// The event type that is handled by the component.
    type Event;

    /// Name of the component.
    fn name(&self) -> &str;

    /// Activate/deactivate a failpoint.
    fn activate_failpoint(&mut self, _activation: &FailpointActivation) {
        // Default is to ignore failpoints.
    }

    /// Processes an event, outputting zero or more effects.
    ///
    /// This function must not ever perform any blocking or CPU intensive work, as it is expected
    /// to return very quickly -- it will usually be called from an `async` function context.
    fn handle_event(
        &mut self,
        effect_builder: EffectBuilder<REv>,
        rng: &mut NodeRng,
        event: Self::Event,
    ) -> Effects<Self::Event>;
}

pub(crate) trait InitializedComponent<REv>: Component<REv> {
    fn state(&self) -> &ComponentState;