task-local-extensions

Crates.iotask-local-extensions
lib.rstask-local-extensions
version0.1.4
sourcesrc
created_at2021-08-31 10:46:13.263848
updated_at2023-03-09 10:29:51.516244
descriptionTask-local container for arbitrary data.
homepage
repositoryhttps://github.com/TrueLayer/task-local-extensions
max_upload_size
id445046
size30,133
Rust OSS (github:truelayer:rust-oss)

documentation

README

task-local-extensions

Provides a type-safe task-local container for arbitrary data keyed by types.

Crates.io Docs.rs CI Coverage Status

How to install

Add task-local-extensions to your dependencies

[dependencies]
# ...
task-local-extensions = "0.1.0"

Usage

Extensions is a container that can store up to one value of each type, so you can insert and retrive values by their type:

use task_local_extensions::Extensions;

let a: i64 = 3;
let mut ext = Extensions::new();
ext.insert(a);
assert_eq!(ext.get::<i64>(), Some(&3));

The crate also provides with_extensions so you set an Extensions instance while running a given task:

use task_local_extensions::{get_local_item, set_local_item, with_extensions, Extensions};

async fn my_task() {
  let a: i64 = get_local_item().await.unwrap(0);
  let msg = format!("The value of a is: {}", a);
  set_local_item(msg).await;
}

let a: i64 = 3;
let (out_ext, _) = with_extensions(Extensions::new().with(a), my_task()).await;
let msg = out_ext.get::<String>().unwrap();
assert_eq!(msg.as_str(), "The value of a is: 3");

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Commit count: 9

cargo fmt