Skip to main content

Parser

Struct Parser 

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

.env file parser.

Construct with Parser::default() for standard behaviour, or [Parser::new(config)] to customise.

Implementations§

Source§

impl Parser

Source

pub fn new(config: ParserConfig) -> Self

Create a parser with a custom ParserConfig.

Source

pub fn parse_file<P: AsRef<Path>>(&self, path: P) -> ParseResult<EnvFile>

Parse a .env file from a filesystem path.

Accepts any type that implements AsRef<Path>&str, String, PathBuf, Path, and OsStr all work without conversion.

This restores the generic signature from the old parser. The new parser narrowed it to &str, which forced callers holding a PathBuf to call .to_str().unwrap().

§Errors

Returns ParseError::FileReadError if the file cannot be read, or any parse error variant if the content is invalid.

§Example
use dotenv_space::core::Parser;

let parser = Parser::default();
let env_file = parser.parse_file(".env")?;
println!("Loaded {} variables", env_file.vars.len());
Source

pub fn parse_content( &self, content: &str, ) -> ParseResult<HashMap<String, String>>

Parse .env content from an in-memory string.

Method name matches the old parser (parse_content) so existing tests and the template command require no changes.

§Example
use dotenv_space::core::Parser;

let parser = Parser::default();
let vars = parser.parse_content("KEY=value\nOTHER=123")?;
assert_eq!(vars["KEY"], "value");

Trait Implementations§

Source§

impl Default for Parser

Correct implementation of the Default trait.

The old parser used a hand-written pub fn default() -> Self method, which triggers clippy::should_implement_trait. This implementation satisfies the trait properly so Parser::default() continues to work at every existing call site without change.

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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.