Struct Dispatcher 

pub struct Dispatcher<T>
where
    T: Dispatchable,
{ /* private fields */ }

Dispatches items from one component to another.

Dispatcher provides an ergonomic interface for sending items to a downstream component. It has support for multiple outputs (a default output, and additional “named” outputs) and provides telemetry around the number of dispatched items as well as the latency of sending them.

Implementations

impl<T> Dispatcher<T>

where T: Dispatchable,

pub fn new(context: ComponentContext) -> Self

Create a new Dispatcher for the given component context.

pub fn add_output( &mut self, output_name: OutputName, ) -> Result<(), GenericError>

Adds an output to the dispatcher.

Errors

If the output already exists, an error is returned.

pub fn attach_sender_to_output( &mut self, output_name: &OutputName, sender: Sender<T>, ) -> Result<(), GenericError>

Attaches a sender to the given output.

Errors

If the output does not exist, an error is returned.

pub fn is_default_output_connected(&self) -> bool

Returns true if the default output is connected to downstream components.

pub fn is_named_output_connected(&self, name: &str) -> bool

Returns true if the named output is connected to downstream components.

pub async fn dispatch(&self, item: T) -> Result<(), GenericError>

Dispatches the given item to the default output.

Errors

If the default output is not set, or there is an error sending to the default output, an error is returned.

pub async fn dispatch_named<N>( &self, output_name: N, item: T, ) -> Result<(), GenericError>

where N: AsRef<str>,

Dispatches the given items to the given named output.

Errors

If a output of the given name is not set, or there is an error sending to the output, an error is returned.

impl<T> Dispatcher<T>

where T: DispatchBuffer,

pub fn buffered(&self) -> Result<BufferedDispatcher<'_, T>, GenericError>

Creates a buffered dispatcher for the default output.

This should generally be used if the items being dispatched are not already collected in a container, or exposed via an iterable type. It allows for efficiently buffering items one-by-one before dispatching them to the underlying output.

Errors

If the default output has not been configured, an error will be returned.

pub fn buffered_named<N>( &self, output_name: N, ) -> Result<BufferedDispatcher<'_, T>, GenericError>

where N: AsRef<str>,

Creates a buffered dispatcher for the given named output.

This should generally be used if the items being dispatched are not already collected in a container, or exposed via an iterable type. It allows for efficiently buffering items one-by-one before dispatching them to the underlying output.

Errors

If the given named output has not been configured, an error will be returned.