#safe #global #traits #once #trait-object

no-std environmental

Set scope-limited values can can be accessed statically

7 stable releases

1.1.4 Nov 30, 2022
1.1.3 May 12, 2021
1.1.2 Sep 30, 2020
1.1.1 Jan 9, 2020
1.0.0 Sep 13, 2018

#73 in Rust patterns

Download history 30686/week @ 2023-06-10 34467/week @ 2023-06-17 28884/week @ 2023-06-24 31691/week @ 2023-07-01 34703/week @ 2023-07-08 29218/week @ 2023-07-15 34622/week @ 2023-07-22 32104/week @ 2023-07-29 30373/week @ 2023-08-05 32493/week @ 2023-08-12 31182/week @ 2023-08-19 50046/week @ 2023-08-26 47067/week @ 2023-09-02 48747/week @ 2023-09-09 38827/week @ 2023-09-16 40739/week @ 2023-09-23

182,392 downloads per month
Used in 590 crates (11 directly)

Apache-2.0

19KB
386 lines

Environmental

.Summary [source, toml]

include::Cargo.toml[lines=2..5]

.Description

include::src/lib.rs[tag=description]

lib.rs:

Safe global references to stack variables.

Set up a global reference with environmental! macro giving it a name and type. Use the using function scoped under its name to name a reference and call a function that takes no parameters yet can access said reference through the similarly placed with function.

Examples

#[macro_use] extern crate environmental;
// create a place for the global reference to exist.
environmental!(counter: u32);
fn stuff() {
  // do some stuff, accessing the named reference as desired.
  counter::with(|i| *i += 1);
}
fn main() {
  // declare a stack variable of the same type as our global declaration.
  let mut counter_value = 41u32;
  // call stuff, setting up our `counter` environment as a reference to our counter_value var.
  counter::using(&mut counter_value, stuff);
  println!("The answer is {:?}", counter_value); // will print 42!
  stuff();	// safe! doesn't do anything.
}

No runtime deps

Features