Skip to main content

EnvFileSource

Struct EnvFileSource 

Source
pub struct EnvFileSource { /* private fields */ }
Expand description

Loads secrets from a .env file.

The file is parsed once at construction time. Supported syntax:

  • KEY=VALUE — plain value
  • KEY="quoted value" — double-quoted (quotes stripped)
  • KEY='quoted value' — single-quoted (quotes stripped)
  • export KEY=VALUE — optional export prefix, followed by spaces or tabs (ignored)
  • # comment — ignored
  • Blank lines — ignored
  • Inline comments: KEY=VALUE # comment (unquoted values only)

Implementations§

Source§

impl EnvFileSource

Source

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

Load from path.

Returns SecretError::FileNotFound if the file does not exist. Use this when the path was explicitly provided by the user (e.g. via --env-file).

Source

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

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

Use this for the default .env path so that projects without a .env file are not forced to create one.

Source

pub fn len(&self) -> usize

Number of entries loaded from the file.

Source

pub fn is_empty(&self) -> bool

Returns true if the file contained no entries.

Trait Implementations§

Source§

impl Debug for EnvFileSource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl SecretSource for EnvFileSource

Source§

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

Load all secrets from this source. Read more
Source§

fn source_name(&self) -> &str

Human-readable name used in error messages and diagnostics.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.