Struct pros_core::task::local::LocalKey

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

A TLS key that owns its data. Can be created with the os_task_local macro.

Implementations

impl<T: 'static> LocalKey<T>

pub const fn new(init: fn() -> T) -> Self

Creates a new local key that lazily initializes its data. init is called to initialize the data when it is first accessed from a new thread.

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

where F: FnOnce(&'static T) -> R,

Passes a reference to the value of this key to the given closure. If the value has not been initialized yet, it will be initialized.

impl<T: 'static> LocalKey<Cell<T>>

pub fn set(&'static self, value: T)

Sets or initializes the value of this key.

If the value was already initialized, it is overwritten. If the value was not initialized, it is initialized with value.

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

where T: Copy,

Gets a copy of the value in this TLS key.

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

where T: Default,

Takes the value out of this TLS key, replacing it with the Default value.

pub fn replace(&'static self, value: T) -> T

Replaces the value in this TLS key with the given one, returning the old value.

impl<T: 'static> LocalKey<RefCell<T>>

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

where F: FnOnce(&T) -> R,

Acquires a reference to the contained value, initializing it if required.

Panics

Panics if the value is currently mutably borrowed.

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

where F: FnOnce(&mut T) -> R,

Acquires a mutable reference to the contained value, initializing it if required.

Panics

Panics if the value is currently borrowed.

pub fn set(&'static self, value: T)

Sets or initializes the value of this key, without running the initializer.

Panics

Panics if the value is currently borrowed.

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

where T: Default,

Takes the value out of this TLS key, replacing it with the Default value.

Panics

Panics if the value is currently borrowed.

pub fn replace(&'static self, value: T) -> T

Replaces the value in this TLS key with the given one, returning the old value.

Panics

Panics if the value is currently borrowed.

Trait Implementations

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

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

Formats the value using the given formatter.