AsyncCommandHandler

Struct AsyncCommandHandler 

Source
pub struct AsyncCommandHandler<M> { /* private fields */ }
Expand description

Handles execution of async commands.

This handler spawns async futures as tokio tasks and sends their results back to the runtime via a message channel. It also handles synchronous command actions directly.

Implementations§

Source§

impl<M: Send + 'static> AsyncCommandHandler<M>

Source

pub fn new() -> Self

Creates a new async command handler.

Source

pub fn execute(&mut self, command: Command<M>)

Executes a command, collecting sync messages and async futures.

Sync actions (Message, Batch, Quit, Callback) are processed immediately. Async actions are collected for later spawning.

Source

pub fn spawn_pending( &mut self, msg_tx: Sender<M>, err_tx: Sender<Box<dyn Error + Send + Sync + 'static>>, cancel: CancellationToken, )

Spawns all pending async futures as tokio tasks.

Each future is spawned with access to the message sender and cancellation token. When a future completes with Some(message), the message is sent to the runtime.

For fallible futures, errors are sent to the error channel instead.

Source

pub fn take_messages(&mut self) -> Vec<M>

Takes all pending sync messages.

Source

pub fn has_pending_futures(&self) -> bool

Returns true if any async futures are pending.

Source

pub fn pending_future_count(&self) -> usize

Returns the number of pending async futures.

Source

pub fn should_quit(&self) -> bool

Returns true if a quit command was executed.

Source

pub fn reset_quit(&mut self)

Resets the quit flag.

Trait Implementations§

Source§

impl<M: Send + 'static> Default for AsyncCommandHandler<M>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<M> Freeze for AsyncCommandHandler<M>

§

impl<M> !RefUnwindSafe for AsyncCommandHandler<M>

§

impl<M> Send for AsyncCommandHandler<M>
where M: Send,

§

impl<M> !Sync for AsyncCommandHandler<M>

§

impl<M> Unpin for AsyncCommandHandler<M>
where M: Unpin,

§

impl<M> !UnwindSafe for AsyncCommandHandler<M>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.