languages/rust
languages/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust synced 2024-10-18 22:43:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #95646 - mgeisler:mention-std-env-var, r=Dylan-DPC

Browse source 
Mention `std::env::var` in `env!`

When searching for how to read an environment variable, I first encountered the `env!` macro. It would have been useful to me if the documentation had included a link to `std::env::var`, which is what I was actually looking for.
This commit is contained in:
Dylan DPC 2022-04-07 06:04:52 +02:00 committed by GitHub
parent f7499a892e 4f08d75375
commit a2df05d4d5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
library/core/src/macros/mod.rs
View file

@ -909,7 +909,10 @@ macro_rules! format_args_nl {
/// Inspects an environment variable at compile time. /// Inspects an environment variable at compile time.
/// ///
/// This macro will expand to the value of the named environment variable at /// This macro will expand to the value of the named environment variable at
/// compile time, yielding an expression of type `&'static str`. /// compile time, yielding an expression of type `&'static str`. Use
/// [`std::env::var`] instead if you want to read the value at runtime.
///
/// [`std::env::var`]: ../std/env/fn.var.html
/// ///
/// If the environment variable is not defined, then a compilation error /// If the environment variable is not defined, then a compilation error
/// will be emitted. To not emit a compile error, use the [`option_env!`] /// will be emitted. To not emit a compile error, use the [`option_env!`]
@ -950,7 +953,10 @@ macro_rules! env {
/// expand into an expression of type `Option<&'static str>` whose value is /// expand into an expression of type `Option<&'static str>` whose value is
/// `Some` of the value of the environment variable. If the environment /// `Some` of the value of the environment variable. If the environment
/// variable is not present, then this will expand to `None`. See /// variable is not present, then this will expand to `None`. See
/// [`Option<T>`][Option] for more information on this type. /// [`Option<T>`][Option] for more information on this type. Use
/// [`std::env::var`] instead if you want to read the value at runtime.
///
/// [`std::env::var`]: ../std/env/fn.var.html
/// ///
/// A compile time error is never emitted when using this macro regardless /// A compile time error is never emitted when using this macro regardless
/// of whether the environment variable is present or not. /// of whether the environment variable is present or not.