Struct Environment 

pub struct Environment<M = ImplicitIndex> {
    pub name: EnvironmentName,
    pub index: EnvironmentIndex,
    /* private fields */
}

Fields

name: EnvironmentName

index: EnvironmentIndex

Implementations

impl<M> Environment<M>

pub fn new(name: EnvironmentName, index: u8) -> Self

pub fn index(&self) -> u8

impl Environment<ImplicitIndex>

pub fn into_explicit(self) -> Environment<ExplicitIndex>

Turn an non explicit environment into an explicit one. An explicit environment will always append the index number to its display names. Whereas a non-explicit one (default) only append the index if it is different than 1.

impl Environment<ExplicitIndex>

pub fn into_implicit(self) -> Environment<ImplicitIndex>

impl<M: IndexStyle> Environment<M>

pub fn long(&self) -> String

pub fn medium(&self) -> String

pub fn short(&self) -> String

pub fn get_dotenv_filename(&self) -> String

Backward-compatible helper for env-specific base filename.

pub fn get_dotenv_secrets_filename(&self) -> String

Backward-compatible helper for env-specific secrets filename.

pub fn get_env_files(&self) -> Vec<String>

All possible .env files for this environment, by family. Order matters: later files override earlier ones.

pub fn load(&self, prefix: Option<&str>) -> Result<()>

Load the .env environment files family.

pub fn merge_env_files(&self) -> Result<PathBuf>

Merge all the .env files of the environment with all variable expanded

Trait Implementations

impl<M: Clone> Clone for Environment<M>

fn clone(&self) -> Environment<M>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: Debug> Debug for Environment<M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: Default> Default for Environment<M>

fn default() -> Environment<M>

Returns the “default value” for a type.

impl<M: IndexStyle> Display for Environment<M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: PartialEq> PartialEq for Environment<M>

fn eq(&self, other: &Environment<M>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M> StructuralPartialEq for Environment<M>