Enum TextParseError 

#[non_exhaustive]
pub enum TextParseError {
    MissingHeader {
        observed: String,
    },
    MissingWireBytesLine {
        observed: String,
    },
    WireBytesTooLarge {
        declared: usize,
    },
    InvalidHexCharacter {
        line: usize,
        character: char,
    },
    OddHexLineLength {
        line: usize,
        observed: usize,
    },
    DeclaredLengthMismatch {
        declared: usize,
        actual: usize,
    },
    WireDecodeFailed {
        inner: IrError,
    },
    WireEncodeFailed {
        inner: IrError,
    },
}

Error returned when a text-format program fails to parse.

Every variant carries an actionable Fix: message rendered via TextParseError::fix_hint. Parsing never panics.

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.

MissingHeader

The program did not start with the vyre_ir v0.1 header.

Fields

observed: String

Snippet of the first line, truncated to 64 characters.

MissingWireBytesLine

The header was present but the second line was not the expected wire_bytes N declaration.

Fields

observed: String

Snippet of the second line, truncated to 64 characters.

WireBytesTooLarge

wire_bytes parsed but exceeded MAX_TEXT_WIRE_BYTES.

Fields

declared: usize

The declared length.

InvalidHexCharacter

A hex line contained a non-hex character.

Fields

line: usize

Offending line number (1-indexed).

character: char

The character that broke the parse.

OddHexLineLength

A hex line’s character count was odd, which cannot round-trip to whole bytes.

Fields

line: usize

Offending line number (1-indexed).

observed: usize

The observed character count.

DeclaredLengthMismatch

Total decoded bytes did not match the declared wire_bytes.

Fields

declared: usize

Declared byte count from the header.

actual: usize

Actual decoded byte count.

WireDecodeFailed

The inner binary wire decoder rejected the byte payload.

The carried error is whatever Program::from_wire emitted: a typed crate::error::IrError whose Display implementation carries the corrective action.

Fields

inner: IrError

The inner decoder error.

WireEncodeFailed

The inner binary wire encoder rejected the program when we tried to serialize it. Only emitted by to_text.

Fields

inner: IrError

The inner encoder error.

Implementations

impl TextParseError

pub fn message(&self) -> String

Human-readable one-line rendering.

pub fn fix_hint(&self) -> &'static str

Actionable Fix:-prefixed hint for the caller.

Trait Implementations

impl Clone for TextParseError

fn clone(&self) -> TextParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextParseError

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

Formats the value using the given formatter.

impl Display for TextParseError

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

Formats the value using the given formatter.

impl Eq for TextParseError

impl Error for TextParseError

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 PartialEq for TextParseError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextParseError