Struct SpawnedLocalTask 

pub struct SpawnedLocalTask<F, ONotifier, Executor>
where
    F: Future,
{ /* private fields */ }

A task that has been spawned onto a local executor.

SpawnedLocalTask is similar to SpawnedTask but designed for executors that are not Send and are tied to a specific thread. Unlike SpawnedTask, this type does not implement Future directly because local executors need to be injected during each poll operation.

Type Parameters

• F - The underlying future type
• ONotifier - The observer notification type for task completion
• Executor - The local executor type that spawned this task

Design Note

Unlike SpawnedTask which embeds a copy of the executor, SpawnedLocalTask only stores a PhantomData marker. This is because local executors may be implemented as references that cannot be stored. Instead, the executor must be provided explicitly when polling the task.

Task-Local Context

When polled via poll, this task sets up the same task-local variables as SpawnedTask, with the addition of:

• crate::task::TASK_LOCAL_EXECUTOR - Reference to the local executor

Examples

Local tasks must be polled explicitly with a reference to their executor:

use some_executor::task::SpawnedLocalTask;
use std::pin::Pin;

// Poll the local task with its executor
let poll_result = Pin::new(&mut spawned).poll(&mut context, &mut executor, None);

Implementations

impl<F: Future, ONotifier, Executor> SpawnedLocalTask<F, ONotifier, Executor>

pub fn hint(&self) -> Hint

Returns the execution hint for this spawned local task.

pub fn label(&self) -> &str

Returns the label of this spawned local task.

Panics

Panics if called while the task is being polled, as the label is temporarily moved into task-local storage during polling.

pub fn priority(&self) -> Priority

Returns the priority of this spawned local task.

pub fn poll_after(&self) -> Instant

Returns the earliest time this task should be polled.

Executors should respect this time and not poll the task before it.

pub fn task_id(&self) -> TaskID

Returns the unique identifier for this spawned local task.

pub fn into_future(self) -> F

Consumes the spawned local task and returns the underlying future.

This is useful if you need to extract the future from the spawned task wrapper, but note that you’ll lose the task metadata and observer infrastructure.

impl<'executor, F, ONotifier, Executor: SomeLocalExecutor<'executor>> SpawnedLocalTask<F, ONotifier, Executor>

where F: Future, ONotifier: ObserverNotified<F::Output>,

pub fn poll( self: Pin<&mut Self>, cx: &mut Context<'_>, executor: &mut Executor, some_executor: Option<Box<dyn SomeExecutor<ExecutorNotifier = Infallible> + 'static>>, ) -> Poll<()>

Polls the spawned local task to advance its execution.

Unlike SpawnedTask which implements Future, local tasks must be polled explicitly with their executor. This is because local executors may be implemented as references that cannot be stored.

Arguments

• cx - The waker context for async execution
• executor - The local executor that owns this task
• some_executor - Optional executor for spawning Send tasks from within this task

Task-Local Variables

During polling, the following task-local variables are set:

• TASK_LABEL - The task’s label
• TASK_ID - The task’s unique identifier
• TASK_PRIORITY - The task’s priority
• IS_CANCELLED - Cancellation status
• crate::task::TASK_LOCAL_EXECUTOR - Reference to the provided local executor
• TASK_EXECUTOR - Reference to the Send executor (if provided)

Returns

• Poll::Ready(()) when the task completes or is cancelled
• Poll::Pending if the task needs to be polled again

Trait Implementations

impl<F: Future, N, E> AsMut<F> for SpawnedLocalTask<F, N, E>

fn as_mut(&mut self) -> &mut F

Converts this type into a mutable reference of the (usually inferred) input type.

impl<F: Future, N, E> AsRef<F> for SpawnedLocalTask<F, N, E>

fn as_ref(&self) -> &F

Converts this type into a shared reference of the (usually inferred) input type.

impl<F: Future, N, E> Debug for SpawnedLocalTask<F, N, E>

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

Formats the value using the given formatter.

impl<'executor, F, ONotifier, Executor> DynLocalSpawnedTask<Executor> for SpawnedLocalTask<F, ONotifier, Executor>

where F: Future, Executor: SomeLocalExecutor<'executor>, ONotifier: ObserverNotified<F::Output>,

fn poll<'ex>( self: Pin<&mut Self>, cx: &mut Context<'_>, executor: &'ex mut Executor, some_executor: Option<Box<dyn SomeExecutor<ExecutorNotifier = Infallible> + 'static>>, ) -> Poll<()>

Polls the task with its associated executor.

fn poll_after(&self) -> Instant

Returns the earliest time this task should be polled.

fn label(&self) -> &str

Returns the task’s label.

fn hint(&self) -> Hint

Returns the task’s execution hint.

fn priority(&self) -> Priority

Returns the task’s priority.

fn task_id(&self) -> TaskID

Returns the task’s unique identifier.