Struct tokio::task::futures::TaskLocalFuture

source · [−]

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

Expand description

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

source

impl<T: 'static, F> Debug for TaskLocalFuture<T, F>where
T: Debug,

source

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

Formats the value using the given formatter. Read more

source

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

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

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

type Output = <F as Future>::Output

The type of value produced on completion.

source

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. Read more

source

impl<'pin, T, F> Unpin for TaskLocalFuture<T, F>where
Origin<'__pin, T, F>: Unpin,
T: 'static,

Auto Trait Implementations

impl<T, F> RefUnwindSafe for TaskLocalFuture<T, F>where
F: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, F> Send for TaskLocalFuture<T, F>where
F: Send,
T: Send,

impl<T, F> Sync for TaskLocalFuture<T, F>where
F: Sync,
T: Sync,

impl<T, F> UnwindSafe for TaskLocalFuture<T, F>where
F: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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<F> IntoFuture for Fwhere
F: Future,

type Output = <F as Future>::Output

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

source

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct tokio::task::futures::TaskLocalFuture

Examples

Trait Implementations

impl<T: 'static, F> Debug for TaskLocalFuture<T, F>where
T: Debug,

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

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

fn drop(&mut self)

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

type Output = <F as Future>::Output

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

impl<'pin, T, F> Unpin for TaskLocalFuture<T, F>where
Origin<'__pin, T, F>: Unpin,
T: 'static,

Auto Trait Implementations

impl<T, F> RefUnwindSafe for TaskLocalFuture<T, F>where
F: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, F> Send for TaskLocalFuture<T, F>where
F: Send,
T: Send,

impl<T, F> Sync for TaskLocalFuture<T, F>where
F: Sync,
T: Sync,

impl<T, F> UnwindSafe for TaskLocalFuture<T, F>where
F: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere
U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for Fwhere
F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct tokio::task::futures::TaskLocalFuture

Examples

Trait Implementations

impl<T: 'static, F> Debug for TaskLocalFuture<T, F>where T: Debug,

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

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

fn drop(&mut self)

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

type Output = <F as Future>::Output

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

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

Auto Trait Implementations

impl<T, F> RefUnwindSafe for TaskLocalFuture<T, F>where F: RefUnwindSafe, T: RefUnwindSafe,

impl<T, F> Send for TaskLocalFuture<T, F>where F: Send, T: Send,

impl<T, F> Sync for TaskLocalFuture<T, F>where F: Sync, T: Sync,

impl<T, F> UnwindSafe for TaskLocalFuture<T, F>where F: UnwindSafe, T: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for Fwhere F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T: 'static, F> Debug for TaskLocalFuture<T, F>where
T: Debug,

impl<'pin, T, F> Unpin for TaskLocalFuture<T, F>where
Origin<'__pin, T, F>: Unpin,
T: 'static,

impl<T, F> RefUnwindSafe for TaskLocalFuture<T, F>where
F: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, F> Send for TaskLocalFuture<T, F>where
F: Send,
T: Send,

impl<T, F> Sync for TaskLocalFuture<T, F>where
F: Sync,
T: Sync,

impl<T, F> UnwindSafe for TaskLocalFuture<T, F>where
F: UnwindSafe,
T: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<F> IntoFuture for Fwhere
F: Future,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,