Skip to main content

DispatchChain

Struct DispatchChain 

Source
pub struct DispatchChain<P, Ctx> { /* private fields */ }
Expand description

Dispatcher builder. Obtained from EventStream::into_dispatcher.

Implementations§

Source§

impl<P, Ctx> DispatchChain<P, Ctx>
where P: EventParser,

Source

pub fn with_ctx(events: EventStream<P>, ctx: Ctx) -> Self

Source

pub fn seq_fallback<E, F>(self, f: F) -> Dispatcher<P, Ctx, Fallback<F>>

The sequential version of Self::fallback

Source

pub fn fallback<E, F, Fut>(self, f: F) -> Dispatcher<P, Ctx, Fallback<F>>
where Ctx: 'static + Send, E: 'static + Send + From<P::Error>, F: Fn(Event, Ctx) -> Fut, Fut: 'static + Send + Future<Output = Result<StreamEvents, E>>,

Accepts all events (crate::Event) unhandled by regular handlers. It is mostly useful for debug logging. Prefer to remove this call in production because it forces full parsing of all event types when by default only the events with set up handlers get parsed.

Source

pub fn seq<Ev, E, F>(self, f: F) -> Dispatcher<P, Ctx, Match<Ev, F>>
where Ev: EventData, F: AsyncFnMut(Arc<Ev>, &mut Ctx) -> Result<StreamEvents, E>,

Register the sequential handler. This call determines the Dispatcher type. You won’t be able to mix seq with on, after calling this all handlers must be seq. See Dispatcher::seq for full docs.

Source

pub fn on<Ev, E, F, Fut>(self, f: F) -> Dispatcher<P, Ctx, Match<Ev, F>>
where Ctx: 'static + Send, E: 'static + Send, Ev: 'static + EventData, F: Fn(Arc<Ev>, Ctx) -> Fut, Fut: 'static + Send + Future<Output = Result<StreamEvents, E>>,

Register the concurrent handler. This call determines the Dispatcher type. You won’t be able to mix seq with on, after calling this all handlers must be on. See Dispatcher::on for full docs. Concurrent handlers require Ctx: 'static + Send + Clone. Ctx is getting cloned into each handler, ensure that impl Clone for Ctx is cheap. If you need to mutate the Ctx you will have to use Arc<Mutex> or similar.

Auto Trait Implementations§

§

impl<P, Ctx> Freeze for DispatchChain<P, Ctx>
where Ctx: Freeze,

§

impl<P, Ctx> !RefUnwindSafe for DispatchChain<P, Ctx>

§

impl<P, Ctx> !Send for DispatchChain<P, Ctx>

§

impl<P, Ctx> !Sync for DispatchChain<P, Ctx>

§

impl<P, Ctx> Unpin for DispatchChain<P, Ctx>
where Ctx: Unpin,

§

impl<P, Ctx> UnsafeUnpin for DispatchChain<P, Ctx>
where Ctx: UnsafeUnpin,

§

impl<P, Ctx> !UnwindSafe for DispatchChain<P, Ctx>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V