Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-lang-nursery/lazy-static.rs
A small macro for defining lazy evaluated static variables in Rust.
https://github.com/rust-lang-nursery/lazy-static.rs
Last synced: 12 days ago
JSON representation
A small macro for defining lazy evaluated static variables in Rust.
- Host: GitHub
- URL: https://github.com/rust-lang-nursery/lazy-static.rs
- Owner: rust-lang-nursery
- License: apache-2.0
- Created: 2014-06-24T08:25:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T02:31:22.000Z (4 months ago)
- Last Synced: 2024-10-25T06:25:28.652Z (18 days ago)
- Language: Rust
- Homepage:
- Size: 958 KB
- Stars: 1,927
- Watchers: 32
- Forks: 111
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-rust-list - typed-arena - lang-nursery/lazy-static.rs?style=social"/> : A small macro for defining lazy evaluated static variables in Rust. (Static Variables)
- awesome-rust-list - typed-arena - lang-nursery/lazy-static.rs?style=social"/> : A small macro for defining lazy evaluated static variables in Rust. (Static Variables)
README
lazy-static.rs
==============
A macro for declaring lazily evaluated statics in Rust.
Using this macro, it is possible to have `static`s that require code to be
executed at runtime in order to be initialized.
This includes anything requiring heap allocations, like vectors or hash maps,
as well as anything that requires non-const function calls to be computed.
[](https://github.com/rust-lang-nursery/lazy-static.rs/actions/workflows/rust.yml)
[](https://crates.io/crates/lazy_static)
[](https://docs.rs/lazy_static)
[](https://github.com/rust-lang-nursery/lazy-static.rs#license)
## Minimum supported `rustc`
`1.40.0+`
This version is explicitly tested in CI and may only be bumped in new minor versions. Any changes to the supported minimum version will be called out in the release notes.
# Getting Started
[lazy-static.rs is available on crates.io](https://crates.io/crates/lazy_static).
It is recommended to look there for the newest released version, as well as links to the newest builds of the docs.
At the point of the last update of this README, the latest published version could be used like this:
Add the following dependency to your Cargo manifest...
```toml
[dependencies]
lazy_static = "1.5.0"
```
...and see the [docs](https://docs.rs/lazy_static) for how to use it.
# Example
```rust
use lazy_static::lazy_static;
use std::collections::HashMap;
lazy_static! {
static ref HASHMAP: HashMap = {
let mut m = HashMap::new();
m.insert(0, "foo");
m.insert(1, "bar");
m.insert(2, "baz");
m
};
}
fn main() {
// First access to `HASHMAP` initializes it
println!("The entry for `0` is \"{}\".", HASHMAP.get(&0).unwrap());
// Any further access to `HASHMAP` just returns the computed value
println!("The entry for `1` is \"{}\".", HASHMAP.get(&1).unwrap());
}
```
# Standard library
It is now possible to easily replicate this crate's functionality in Rust's standard library with [`std::sync::OnceLock`](https://doc.rust-lang.org/std/sync/struct.OnceLock.html). The example above could also be written as:
```rust
use std::collections::HashMap;
use std::sync::OnceLock;
fn hashmap() -> &'static HashMap {
static HASHMAP: OnceLock> = OnceLock::new();
HASHMAP.get_or_init(|| {
let mut m = HashMap::new();
m.insert(0, "foo");
m.insert(1, "bar");
m.insert(2, "baz");
m
})
}
fn main() {
// First access to `HASHMAP` initializes it
println!("The entry for `0` is \"{}\".", hashmap().get(&0).unwrap());
// Any further access to `HASHMAP` just returns the computed value
println!("The entry for `1` is \"{}\".", hashmap().get(&1).unwrap());
}
```
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
at your option.
### Contribution
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.