Struct Injector

pub struct Injector<S> { /* private fields */ }

An injector queue for spawning tasks on multiple Scheduler instances.

Implementations

impl<S: Schedule> Injector<S>

pub const unsafe fn new_with_static_stub(stub: &'static TaskStub) -> Self

Returns a new injector queue.

Safety

The “stub” provided must ONLY EVER be used for a single Injector instance. Re-using the stub for multiple distributors or schedulers may lead to undefined behavior.

pub fn spawn_allocated<STO, F>( &self, task: STO::StoredTask, ) -> JoinHandle<F::Output>

where F: Future + Send + 'static, F::Output: Send + 'static, STO: Storage<S, F>,

Spawns a pre-allocated task on the injector queue.

The spawned task will be executed by any Scheduler/StaticScheduler instance that runs tasks from this queue.

This method is used to spawn a task that requires some bespoke procedure of allocation, typically of a custom Storage implementor. See the documentation for the Storage trait for more details on using custom task storage.

When the “alloc” feature flag is available, tasks that do not require custom storage may be spawned using the Injector::spawn method, instead.

This method returns a JoinHandle that can be used to await the task’s output. Dropping the JoinHandle detaches the spawned task, allowing it to run in the background without awaiting its output.

pub fn try_steal(&self) -> Result<Stealer<'_, S>, TryStealError>

Attempt to take tasks from the injector queue.

Returns

• Ok(Stealer`)) if tasks can be spawned from the injector queue.
• Err(TryStealError::Empty) if there were no tasks in this injector queue.
• Err(TryStealError::Busy) if another worker was already taking tasks from this injector queue.

impl<S: Schedule> Injector<S>

pub fn new() -> Self

Available on crate feature alloc only.

Returns a new Injector queue with a dynamically heap-allocated TaskStub.

pub fn spawn<F>(&self, future: F) -> JoinHandle<F::Output>

where F: Future + Send + 'static, F::Output: Send + 'static,

Available on crate feature alloc only.

Spawns a new task on the injector queue, to execute on any Scheduler/StaticScheduler instance that runs tasks from this queue.

This method returns a JoinHandle that can be used to await the task’s output. Dropping the JoinHandle detaches the spawned task, allowing it to run in the background without awaiting its output.

Trait Implementations

impl<S> Debug for Injector<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Schedule> Default for Injector<S>

Available on crate feature alloc only.

fn default() -> Self

Returns the “default value” for a type.