Skip to main content

CommandRunner

Struct CommandRunner 

Source
pub struct CommandRunner<T: ICommandInfo> { /* private fields */ }
Expand description

Queue and execute commands across a pool of workers.

Implementations§

Source§

impl<T: ICommandInfo + 'static> CommandRunner<T>

Source

pub fn new( mediator: Arc<CommandMediator<T>>, registry: Arc<CommandRegistry<T>>, workers: Arc<WorkerPool<T>>, ) -> Self

Create a new CommandRunner.

Source

pub async fn start(&self, worker_count: usize)

Start any number of workers.

Each worker will have a unique ID.

Status will be set to Running.

Source

pub async fn drain(&self)

Stop workers after draining the queue.

Source

pub async fn stop(&self)

Stop workers after their current work is complete

Source

pub async fn queue_request<R: Executable + Into<T::Request> + Send + Sync + 'static>( &self, request: R, ) -> Result<(), Report<QueueError>>

Queue a command as a request.

Source

pub async fn get_commands( &self, ) -> MutexGuard<'_, HashMap<T::Request, CommandStatus<T>>>

Lock and return the current command status map.

The MutexGuard must be dropped promptly or Worker execution will block.

Trait Implementations§

Source§

impl<T: ICommandInfo + 'static> Service for CommandRunner<T>

Source§

type Error = ServiceError

Error type returned by Service::from_services.
Source§

async fn from_services( services: &ServiceProvider, ) -> Result<Self, Report<Self::Error>>

Create a new instance by resolving dependencies from the ServiceProvider.

Auto Trait Implementations§

§

impl<T> Freeze for CommandRunner<T>

§

impl<T> !RefUnwindSafe for CommandRunner<T>

§

impl<T> Send for CommandRunner<T>

§

impl<T> Sync for CommandRunner<T>

§

impl<T> Unpin for CommandRunner<T>

§

impl<T> UnsafeUnpin for CommandRunner<T>

§

impl<T> !UnwindSafe for CommandRunner<T>

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more