# State   [![ci.svg]][ci] [![crates.io]][crate] [![docs.rs]][docs]
[crates.io]: https://img.shields.io/crates/v/state.svg
[crate]: https://crates.io/crates/state
[docs.rs]: https://docs.rs/state/badge.svg
[docs]: https://docs.rs/state
[ci.svg]: https://github.com/SergioBenitez/state/workflows/CI/badge.svg
[ci]: https://github.com/SergioBenitez/state/actions
A Rust library for safe and effortless global and thread-local state management.
```rust
extern crate state;
static GLOBAL: state::Storage<u32> = state::Storage::new();
GLOBAL.set(42);
assert_eq!(*GLOBAL.get(), 42);
```
This library can be used to easily implement:
* Global Singletons
* Global or Local Cached Values
* Thread-Local Thunks
* Dynamic Thread-Local Data
* Typed Containers
See the [documentation](https://docs.rs/state) for more.
## Usage
Include `state` in your `Cargo.toml` `[dependencies]`:
```toml
[dependencies]
state = "0.4"
```
Thread-local state management is not enabled by default. You can enable it
via the `tls` feature:
```toml
[dependencies]
state = { version = "0.4", features = ["tls"] }
```
## Testing
This library is extensively tested. Tests can be found in `tests/main.rs`. You
can run the tests with `cargo test --all-features`.
## License
State is licensed under either of the following, at your option:
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)