结构体 LocalKey 

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

用于 task-local 数据的 key。

此类型由 task_local! 宏生成。

与 std::thread::LocalKey 不同，tokio::task::LocalKey 不会在首次访问时惰性初始化值。相反，值会在包含 task-local 的 future 第一次被 Tokio 等 futures 执行器 poll 时初始化。

示例

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

NUMBER.scope(1, async move {
    assert_eq!(NUMBER.get(), 1);
}).await;

NUMBER.scope(2, async move {
    assert_eq!(NUMBER.get(), 2);

    NUMBER.scope(3, async move {
        assert_eq!(NUMBER.get(), 3);
    }).await;
}).await;

实现

impl<T: 'static> LocalKey<T>

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

where F: Future,

将值 T 设置为 future F 的 task-local 值。

scope 完成后，task-local 将被丢弃。

Panics

如果你在同一个 LocalKey 上调用 with 或 try_with 时 poll 返回的 future，则对 poll 的调用将 panic。

示例

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

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

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

where F: FnOnce() -> R,

将值 T 设置为闭包 F 的 task-local 值。

sync_scope 完成后，task-local 将被丢弃。

Panics

如果在同一个 LocalKey 上调用 with 或 try_with 时调用此方法，则会 panic。

示例

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

NUMBER.sync_scope(1, || {
    println!("task local value: {}", NUMBER.get());
});

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

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

访问当前 task-local 并运行提供的闭包。

Panics

如果 task-local 没有设置值，此函数将 panic。

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

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

访问当前 task-local 并运行提供的闭包。

如果与该 key 关联的 task-local 不存在，此方法将返回一个 AccessError。关于会 panic 的变体，请参阅 with。

impl<T: Clone + 'static> LocalKey<T>

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

如果 task-local 值实现了 Clone，则返回该 task-local 值的一个副本。

Panics

如果 task-local 没有设置值，此函数将 panic。

pub fn try_get(&'static self) -> Result<T, AccessError>

如果 task-local 值实现了 Clone，则返回该 task-local 值的一个副本。

如果与该 key 关联的 task-local 不存在，此方法将返回一个 AccessError。关于会 panic 的变体，请参阅 get。

Trait 实现

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

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

使用给定的格式化器格式化此值。 更多信息