Struct StaticKey

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

An object that is rarely modified but frequently matched on.

This type can only be constructed using static_key! macro.

Implementations

impl<T> StaticKey<T>

pub fn with<R>(&self, callback: impl FnOnce(&T) -> R) -> R

Acquire a reference to the value of this key.

Performance

StaticKeys are not intended to be used like cell/locks, so this is not an especially optimised accessor. This method should be rarely used.

pub fn get(&self) -> T

where T: Copy,

Returns a copy of the value of this key.

Performance

StaticKeys are not intended to be used like cell/locks, so this is not an especially optimised accessor. This method should be rarely used.

pub fn set(&self, value: T)

Sets the value of this key.

Performance

StaticKeys are not intended to be frequently updated, so this is slow in performance. This method should be rarely used.

Examples found in repository

examples/main.rs (line 22)

pub fn update() {
    loop {
        std::thread::sleep(Duration::from_secs(1));
        println!("= true");
        KEY.set(true);
        std::thread::sleep(Duration::from_secs(1));
        println!("= false");
        KEY.set(false);
    }
}

Trait Implementations

impl<T> Debug for StaticKey<T>

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

Formats the value using the given formatter.

impl<T: Send> Send for StaticKey<T>

impl<T: Send> Sync for StaticKey<T>