Enum DiagnosticCode 

#[non_exhaustive]
pub enum DiagnosticCode {
    InvalidKey,
    UnterminatedQuote,
    TrailingText,
    UnknownEscape,
    DuplicateKey,
    BareKey,
    NonPosixKey,
    TightHash,
    Backtick,
    ByteOrderMark,
    LoneCarriageReturn,
    ForbiddenBareKey,
    ForbiddenByteOrderMark,
    InvalidEscape,
    IgnoredStatement,
    LineTooLong,
}

Stable diagnostic identities; messages are descriptive, not API identifiers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidKey

A key is empty or contains a character outside the selected key alphabet.

UnterminatedQuote

A quoted value has no matching delimiter before EOF.

TrailingText

Non-comment text follows a closing quote.

UnknownEscape

An unknown double-quoted escape is retained literally.

DuplicateKey

An earlier assignment has the same key.

BareKey

A declaration has no equals sign or value.

NonPosixKey

A key is not a POSIX shell variable name.

TightHash

A hash attached to an unquoted value is literal, not a comment.

Backtick

Backticks are literal, not a Portable quoting style.

ByteOrderMark

A UTF-8 byte-order mark precedes the source body.

LoneCarriageReturn

A lone carriage return is retained as a source line ending.

ForbiddenBareKey

The selected policy forbids key-only declarations.

ForbiddenByteOrderMark

The selected policy forbids a leading byte-order mark.

InvalidEscape

The selected policy rejects an unrecognized escape.

IgnoredStatement

A statement is retained but ignored by the selected dialect.

LineTooLong

A source line exceeds the selected scanner’s byte limit.

Implementations

impl DiagnosticCode

pub const fn as_str(self) -> &'static str

Stable machine-readable identity, independent of enum order and wording.

pub const fn severity(self) -> Severity

The default severity assigned to this diagnostic identity.

pub const fn message(self) -> &'static str

A human-readable explanation; callers should match codes, not this text.

Trait Implementations

impl Clone for DiagnosticCode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DiagnosticCode

impl Debug for DiagnosticCode

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

Formats the value using the given formatter.

impl Eq for DiagnosticCode

impl Hash for DiagnosticCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DiagnosticCode

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DiagnosticCode