Crates.io | dotenv_codegen_impl |
lib.rs | dotenv_codegen_impl |
version | 0.1.0 |
source | src |
created_at | 2018-01-01 19:43:58.873377 |
updated_at | 2018-01-01 19:43:58.873377 |
description | A `dotenv` implementation for Rust |
homepage | https://github.com/purpliminal/rust-dotenv |
repository | https://github.com/purpliminal/rust-dotenv |
max_upload_size | |
id | 45141 |
size | 3,483 |
Achtung! This is a v0.* version! Expect bugs and issues all around. Submitting pull requests and issues is highly encouraged!
Quoting bkeepers/dotenv:
Storing configuration in the environment is one of the tenets of a twelve-factor app. Anything that is likely to change between deployment environments–such as resource handles for databases or credentials for external services–should be extracted from the code into environment variables.
This library is meant to be used on development or testing environments in
which setting environment variables is not practical. It loads environment
variables from a .env
file, if available, and mashes those with the actual
environment variables provided by the operative system.
The easiest and most common usage consists on calling dotenv::dotenv
when the
application starts, which will load environment variables from a file named
.env
in the current directory or any of its parents; after that, you can just call
the environment-related method you need as provided by std::os
.
If you need finer control about the name of the file or its location, you can
use the from_filename
and from_path
methods provided by the crate.
dotenv_codegen
provides the dotenv!
macro, which
behaves identically to env!
, but first tries to load a .env
file at compile
time.
A .env
file looks like this:
# a comment, will be ignored
REDIS_ADDRESS=localhost:6379
MEANING_OF_LIFE=42
You can optionally prefix each line with the word export
, which will
conveniently allow you to source the whole file on your shell.
A sample project using Dotenv would look like this:
extern crate dotenv;
use dotenv::dotenv;
use std::env;
fn main() {
dotenv().ok();
for (key, value) in env::vars() {
println!("{}: {}", key, value);
}
}
dotenv!
macroAdd dotenv_codegen
to your dependencies, and add the following to the top of
your crate:
#[macro_use]
extern crate dotenv_codegen;
Then, in your crate:
fn main() {
println!("{}", dotenv!("MEANING_OF_LIFE"));
}