Enum InvalidFramingReason 

#[non_exhaustive]
pub enum InvalidFramingReason {
    LengthExceedsMax {
        prefix: u64,
        max: u64,
    },
    LengthZero,
    Truncated,
    HeaderMissing,
}

Reasons a streamed framing wrapper is rejected.

Distinct from WalExportError so callers can match the framing failure mode without needing to reach into a tuple variant. BufferedWalSink uses the variants individually when constructing rejection paths.

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.

LengthExceedsMax

Length prefix exceeds MAX_RECORD_BYTES. Carries both the observed prefix and the bound for caller diagnostics.

Operator response: investigate hostile stream injection or fragment producer. The 16 MiB ceiling is a fail-secure hard bound — a legitimate producer should never emit a frame at this size.

Fields

prefix: u64

The prefix value that triggered rejection.

max: u64

The bound that was exceeded — equals MAX_RECORD_BYTES.

LengthZero

Length prefix is zero — empty records are disallowed.

Every frame must carry a payload; the reader rejects defensively to prevent silent-no-op streams.

Operator response: re-emit (the producer should never emit a length-zero frame).

Truncated

Stream truncated — bytes ended mid-record before the full length-prefixed payload arrived. Distinguishes operator-side disk failure from valid-but-shorter streams.

Operator response: re-emit; source likely truncated mid- write (disk full, network drop, process crash). The reader surfaces this distinct from HeaderMissing so the operator can distinguish “never started” from “started but cut off”.

HeaderMissing

Stream header magic missing or mismatched at stream start. Triggered when the leading 8 bytes do not equal STREAM_HEADER_MAGIC.

Operator response: verify the source stream is an ARKHEXP-format export (not, e.g., an L0 WAL file or an unrelated binary). Distinct from crate::wal_export::WalExportError::UnsupportedStreamVersion which signals “magic present but version unrecognised”.

Trait Implementations

impl Debug for InvalidFramingReason

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

Formats the value using the given formatter.

impl Display for InvalidFramingReason

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

Formats the value using the given formatter.

impl Error for InvalidFramingReason

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.