Enum TensogramError 

#[non_exhaustive]
pub enum TensogramError {
    Framing(String),
    Metadata(String),
    Encoding(String),
    Compression(String),
    Object(String),
    Io(Error),
    HashMismatch {
        object_index: Option<usize>,
        expected: String,
        actual: String,
    },
    MissingHash {
        object_index: usize,
    },
    Remote(String),
}

Top-level error type for the tensogram crate.

Variant guarantee. The enum is #[non_exhaustive] so future versions can add new error categories (e.g. for new wire-format features or external system integrations) without breaking downstream match arms. Callers should always include a _ => fallback when matching on TensogramError.

Inner-crate errors (tensogram_encodings::PipelineError, CompressionError, PackingError, ShuffleError, bitmask::MaskError) are converted into Encoding / Compression variants via e.to_string() at the boundary — the source error chain is collapsed. This keeps the error strings stable across language bindings (Python ValueError, C++ typed exceptions, TypeScript EncodingError) at the cost of losing programmatic access to the source. Tightening this to #[from] source chains is a deliberate non-goal until a concrete consumer needs structured introspection.

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.

Framing(String)

Wire-format structural error: bad magic, unknown frame type, length mismatches, missing ENDF marker, etc.

Metadata(String)

CBOR metadata error: bad CBOR, missing required keys, type mismatches on per-codec params, mask method validation, etc.

Encoding(String)

Encoding / pipeline error: simple_packing rejection, shuffle failure, allocation failure on a descriptor-derived size, codec param invalid for the dtype, etc.

Compression(String)

Compression error: codec library failure, decompression short-fetch, codec not compiled in, etc.

Object(String)

Object error: out-of-range index into a data-object array.

Io(Error)

I/O error from the underlying file or socket. Source-chained via #[from] so e.source() returns the original std::io::Error.

HashMismatch

Frame-body hash digest disagreement between the stored slot and the recomputed digest. Both digests are 16-character lowercase hex strings of the xxh3-64 value.

object_index carries the 0-based index of the data-object frame whose hash failed when the error originates from the decode-time verification path (DecodeOptions::verify_hash); it is None for header / footer / index / hash / preceder frames where an object index has no meaning, and for callers that don’t have one available (e.g. legacy verify_frame_hash direct uses).

Display form: "hash mismatch on object N: expected X, got Y" when object_index is Some(N), or "hash mismatch on frame: expected X, got Y" when it is None. The Some / None Rust internals are deliberately not surfaced — see [fmt_object_location].

Fields

object_index: Option<usize>

expected: String

actual: String

MissingHash

Decode-time hash verification was requested via crate::decode::DecodeOptions::verify_hash but the frame’s FrameFlags::HASH_PRESENT bit is clear, so no digest was recorded for this frame.

Reasons this can happen in well-formed messages:

• the producer encoded with EncodeOptions::hashing=false (every frame’s flag is clear).
• an attacker / lossy transformation cleared the flag bit.

Resolutions: decode without verify_hash, or re-encode the source with EncodeOptions::hashing=true.

object_index carries the 0-based index of the data-object frame whose flag was clear. The decode-time path (the only in-tree caller) always populates this with the offending object’s index so the user can act on the failure.

Fields

object_index: usize

Remote(String)

Remote object-store error: HTTP transport failure, malformed URL, missing credentials, etc.

Trait Implementations

impl Debug for TensogramError

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

Formats the value using the given formatter.

impl Display for TensogramError

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

Formats the value using the given formatter.

impl Error for TensogramError

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 TensogramError

fn from(source: Error) -> Self

Converts to this type from the input type.