Enum ParseError 

pub enum ParseError {
    FileReadError(Error),
    InvalidFormat {
        line: usize,
        message: String,
    },
    InvalidKey {
        line: usize,
        key: String,
    },
    UndefinedVariable {
        line: usize,
        var: String,
    },
    CircularExpansion {
        line: usize,
        cycle: String,
    },
    UnterminatedString {
        line: usize,
    },
    ExpansionDepthExceeded {
        line: usize,
        max: usize,
    },
}

Structured parse errors with line numbers and context.

Implements std::error::Error via thiserror and converts into anyhow::Error automatically when used with the ? operator inside a function that returns anyhow::Result. This means no changes are needed in command files that currently do:

let env_file = parser
    .parse_file(&env)
    .with_context(|| format!("Failed to parse {}", env))?;

Variants

FileReadError(Error)

The file could not be read from disk.

InvalidFormat

A line did not contain a = separator (and is not a comment or blank).

Fields

line: usize

message: String

InvalidKey

A key contains characters outside [A-Za-z][A-Za-z0-9_]*.

Fields

line: usize

key: String

UndefinedVariable

A ${VAR} or $VAR reference names a variable that was not defined earlier in the file.

Fields

line: usize

var: String

CircularExpansion

Two or more variables reference each other in a cycle.

Fields

line: usize

cycle: String

UnterminatedString

A quoted string was opened but never closed.

Fields

line: usize

ExpansionDepthExceeded

Expansion depth exceeded ParserConfig::max_expansion_depth.

Fields

line: usize

max: usize

Trait Implementations

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for ParseError

fn from(source: Error) -> Self

Converts to this type from the input type.