Struct tokio::task::futures::TaskLocalFuture

pub struct TaskLocalFuture<T, F>
where
    T: 'static,
{ /* private fields */ }

A future that sets a value T of a task local for the future F during its execution.

The value of the task-local must be 'static and will be dropped on the completion of the future.

Created by the function LocalKey::scope.

Examples

tokio::task_local! {
    static NUMBER: u32;
}

NUMBER.scope(1, async move {
    println!("task local value: {}", NUMBER.get());
}).await;

Trait Implementations

impl<T, F> Debug for TaskLocalFuture<T, F>

where T: Debug + 'static,

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

Formats the value using the given formatter.

impl<T: 'static, F> Drop for TaskLocalFuture<T, F>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: 'static, F: Future> Future for TaskLocalFuture<T, F>

type Output = <F as Future>::Output

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<'__pin, T, F> Unpin for TaskLocalFuture<T, F>

where __Origin<'__pin, T, F>: Unpin, T: 'static,