Enum StreamError 

pub enum StreamError {
    Io(Error),
    Utf8 {
        line: usize,
        message: String,
    },
    Syntax {
        line: usize,
        message: String,
    },
    Schema {
        line: usize,
        message: String,
    },
    Header(String),
    MissingVersion,
    InvalidVersion(String),
    OrphanRow {
        line: usize,
        message: String,
    },
    ShapeMismatch {
        line: usize,
        expected: usize,
        got: usize,
    },
    Timeout {
        elapsed: Duration,
        limit: Duration,
    },
    LineTooLong {
        line: usize,
        length: usize,
        limit: usize,
    },
    InvalidUtf8 {
        line: usize,
        error: Utf8Error,
    },
}

Errors that can occur during streaming parsing.

All variants include contextual information to help diagnose and fix issues. Most errors include line numbers; use the line() method to extract them uniformly.

Examples

Creating Errors

use hedl_stream::StreamError;

let err = StreamError::syntax(42, "unexpected token");
assert_eq!(err.line(), Some(42));

let schema_err = StreamError::schema(10, "type not found");
assert_eq!(schema_err.line(), Some(10));

Error Display

use hedl_stream::StreamError;

let err = StreamError::syntax(5, "missing colon");
let msg = format!("{}", err);
assert!(msg.contains("line 5"));
assert!(msg.contains("missing colon"));

Variants

Io(Error)

IO error.

Utf8

Invalid UTF-8 encoding.

Fields

line: usize

Line number where the invalid encoding was found.

message: String

Description of the encoding error.

Syntax

Syntax error.

Fields

line: usize

Line number where the syntax error occurred.

message: String

Description of the syntax error.

Schema

Schema error.

Fields

line: usize

Line number where the schema error occurred.

message: String

Description of the schema error.

Header(String)

Invalid header.

MissingVersion

Missing version directive.

InvalidVersion(String)

Invalid version.

OrphanRow

Orphan row (child without parent).

Fields

line: usize

Line number of the orphan row.

message: String

Description of the orphan row error.

ShapeMismatch

Shape mismatch.

Fields

line: usize

Line number where the mismatch occurred.

expected: usize

Expected number of columns.

got: usize

Actual number of columns found.

Timeout

Timeout exceeded during parsing.

Fields

elapsed: Duration

Time elapsed before timeout.

limit: Duration

Configured timeout limit.

LineTooLong

Line length exceeds configured maximum.

Fields

line: usize

Line number that exceeded the limit.

length: usize

Actual length in bytes.

limit: usize

Maximum allowed length in bytes.

InvalidUtf8

Invalid UTF-8 encoding in input.

Fields

line: usize

Line number with invalid encoding.

error: Utf8Error

The underlying UTF-8 decoding error.

Implementations

impl StreamError

pub fn syntax(line: usize, message: impl Into<String>) -> Self

Create a syntax error.

pub fn schema(line: usize, message: impl Into<String>) -> Self

Create a schema error.

pub fn orphan_row(line: usize, message: impl Into<String>) -> Self

Create an orphan row error.

pub fn line(&self) -> Option<usize>

Get the line number if available.

Trait Implementations

impl Debug for StreamError

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

Formats the value using the given formatter.

impl Display for StreamError

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

Formats the value using the given formatter.

impl Error for StreamError

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 StreamError

fn from(source: Error) -> Self

Converts to this type from the input type.