Struct LocalKey 

pub struct LocalKey<T: 'static> { /* private fields */ }

A task-local key, declared with task_local!.

Implementations

impl<T: 'static> LocalKey<T>

pub fn scope<F: Future>( &'static self, value: T, future: F, ) -> TaskLocalFuture<T, F>

A future that runs future with the key set to value in each of its polls, and drops future (when it is dropped early) with the value still set.

pub fn sync_scope<F: FnOnce() -> R, R>(&'static self, value: T, f: F) -> R

Runs f with the key set to value, then unsets it.

pub fn with<F: FnOnce(&T) -> R, R>(&'static self, f: F) -> R

Runs f on the key’s value.

Panics

Where no scope set the key; try_with answers an AccessError instead.

pub fn try_with<F: FnOnce(&T) -> R, R>( &'static self, f: F, ) -> Result<R, AccessError>

Runs f on the key’s value, or answers an AccessError where no scope set it.

pub fn get(&'static self) -> T

where T: Clone,

A clone of the key’s value.

Panics

Where no scope set the key.

Trait Implementations

impl<T: 'static> Debug for LocalKey<T>

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

Formats the value using the given formatter.