Struct EnvFileSource 

pub struct EnvFileSource { /* private fields */ }

Loads secrets from a .env file.

This struct parses a .env file at construction time and caches the key-value pairs. Once constructed, the source can be cloned and reused; each call to load returns a copy of the cached map.

Supported syntax

• KEY=VALUE: plain value
• KEY="quoted value": double-quoted values with quotes stripped
• KEY='quoted value': single-quoted values with quotes stripped
• export KEY=VALUE: optional export prefix followed by whitespace (ignored)
• # comment: lines starting with # are skipped
• Blank lines: ignored
• Inline comments: KEY=VALUE # comment (trailing comments on unquoted values only; quoted values preserve all characters including #)
• UTF-8 BOM: stripped from the start of the file if present

Errors

Construction fails if the file does not exist, is unreadable, or contains invalid syntax. Use load_optional for paths that may not exist.

Implementations

impl EnvFileSource

pub fn load(path: impl Into<PathBuf>) -> Result<Self, SecretError>

Load from path, requiring the file to exist.

Returns SecretError::FileNotFound if the file does not exist, or SecretError::Io if the file is unreadable. Use this when the path was explicitly provided by the user (e.g. via --env-file CLI flag).

For optional files (like the default .env), use load_optional instead.

Errors

Returns an error if the file does not exist, cannot be read, or contains invalid syntax.

Examples

use lightshuttle_secrets::EnvFileSource;

let source = EnvFileSource::load(".env")?;
println!("Loaded {} secrets", source.len());

pub fn load_optional( path: impl Into<PathBuf>, ) -> Result<Option<Self>, SecretError>

Load from path if it exists, returning None if the file is absent.

This is useful for optional configuration files like the default .env path. If the file is absent, no error is raised. If the file exists but is malformed, an error is returned.

Errors

Returns an error only if the file exists but cannot be read or contains invalid syntax.

Examples

use lightshuttle_secrets::EnvFileSource;

if let Some(source) = EnvFileSource::load_optional(".env")? {
    println!("Using {} secrets", source.len());
} else {
    println!("No .env file; using defaults");
}

pub fn len(&self) -> usize

Number of entries loaded from the file.

Returns the count of successfully parsed KEY=VALUE pairs.

pub fn is_empty(&self) -> bool

Returns true if the file contained no entries.

This is true if the file was empty, contained only comments and blank lines, or was otherwise parsed to zero key-value pairs.

Trait Implementations

impl Debug for EnvFileSource

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

Formats the value using the given formatter.

impl SecretSource for EnvFileSource

fn load(&self) -> Result<HashMap<String, String>, SecretError>

Load all secrets from this source.

fn source_name(&self) -> &str

Human-readable name used in error messages and diagnostics.