std::env::set_var safely
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..964d1a3 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# `env` + + + +Provides a safe interface for <code>[std::env](http://doc.rust-lang.org/std/env)::{[set_var](https://doc.rust-lang.org/std/env/fn.set_var.html), [remove_var](https://doc.rust-lang.org/std/env/fn.remove_var.html)}</code>. + +## Rationale + +Since [#124636](https://github.com/rust-lang/rust/pull/124636), `std::env::set_var` and `std::env::remove_var}` have become unsafe, due to their being unsafe when in a multi-threaded unix context[^1]. + +This crate wraps these functions, checking if these conditions are met at runtime, such that these functions are safe to call. + +[^1]: https://github.com/rust-lang/rust/issues/27970 |