Struct Builder

pub struct Builder<'a, S> { /* private fields */ }

Builds a new Task prior to spawning it.

Implementations

impl<'a, S: Schedule + 'static> Builder<'a, S>

pub fn name(self, name: &'a str) -> Self

Adds a name to the tasks produced by this builder.

This will set the task.name tracing field of spans generated for this task, if the “tracing-01” or “tracing-02” feature flags are enabled.

By default, tasks are unnamed.

pub fn kind(self, kind: &'static str) -> Self

Adds a static string which describes the type of the configured task.

Generally, this is set by the runtime, rather than by user code — kinds should describe general categories of task, such as “local” or “blocking”, rather than identifying specific tasks in an application. The name field should be used instead for naming specific tasks within an application.

This will set the task.kind tracing field of spans generated for this task, if the “tracing-01” or “tracing-02” feature flags are enabled.

By default, tasks will have the kind “task”.

pub fn location(self, location: Location<'a>) -> Self

Overrides the task’s source code location.

By default, tasks will be recorded as having the location from which they are spawned. This may be overriden by the runtime if needed.

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 new task in a custom allocation, with this builder’s configured settings.

Note that the StoredTask must be bound to the same scheduler instance as this task’s scheduler!

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.

impl Builder<'_, &'static LocalStaticScheduler>

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

where F: Future + 'static, F::Output: 'static, STO: Storage<&'static LocalStaticScheduler, F>,

Spawns a new !Send task in a custom allocation, with this builder’s configured settings.

This method is capable of spawning futures which do not implement Send. Therefore, it is only available when this Builder was returned by a LocalStaticScheduler

Note that the StoredTask must be bound to the same scheduler instance as this task’s scheduler!

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.

impl<S: Schedule + 'static> Builder<'_, S>

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 with this builder’s configured settings.

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.

impl Builder<'_, &'static LocalStaticScheduler>

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

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

Available on crate feature alloc only.

Spawns a new !Send task with this builder’s configured settings.

This method is capable of spawning futures which do not implement Send. Therefore, it is only available when this Builder was returned by a LocalStaticScheduler

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.

impl Builder<'_, LocalScheduler>

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

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

Available on crate feature alloc only.

Spawns a new !Send task with this builder’s configured settings.

This method is capable of spawning futures which do not implement Send. Therefore, it is only available when this Builder was returned by a LocalScheduler

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 spawn_local_allocated<STO, F>( &self, task: STO::StoredTask, ) -> JoinHandle<F::Output>

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

Available on crate feature alloc only.

Spawns a new !Send task in a custom allocation, with this builder’s configured settings.

This method is capable of spawning futures which do not implement Send. Therefore, it is only available when this Builder was returned by a LocalStaticScheduler

Note that the StoredTask must be bound to the same scheduler instance as this task’s scheduler!

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<'a, S: Clone> Clone for Builder<'a, S>

fn clone(&self) -> Builder<'a, S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, S: Debug> Debug for Builder<'a, S>

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

Formats the value using the given formatter.