Enum CrushError 

pub enum CrushError {
    Plugin(PluginError),
    Timeout(TimeoutError),
    Validation(ValidationError),
    Io(Error),
    Cancelled,
    InvalidConfig(String),
    VersionMismatch {
        file_version: String,
        current_version: String,
    },
    InvalidFormat(String),
    ChecksumMismatch {
        block_index: u64,
        expected: u32,
        actual: u32,
    },
    ExpansionLimitExceeded {
        block_index: u64,
    },
    IndexCorrupted(String),
}

Main error type for Crush library operations

Variants

Plugin(PluginError)

Plugin-related errors (registration, discovery, execution)

Timeout(TimeoutError)

Timeout-related errors (plugin operations exceeding limits)

Validation(ValidationError)

Validation errors (invalid input, corrupted data, malformed headers)

Io(Error)

I/O errors (file operations, network, etc.)

Cancelled

Operation was cancelled by user (Ctrl+C) or programmatically

InvalidConfig(String)

Configuration validation failed (e.g. block_size out of range)

VersionMismatch

The compressed file was produced by a different engine version. Decompression is refused; the user must use the named producer version.

Fields

file_version: String

Version string of the engine that produced the file.

current_version: String

Version string of the currently running engine.

InvalidFormat(String)

File header magic bytes do not match the expected CRSH signature.

ChecksumMismatch

A block’s CRC32 checksum does not match the stored value.

Fields

block_index: u64

Zero-based index of the corrupt block.

expected: u32

CRC32 value stored in the block header.

actual: u32

CRC32 value computed from the decompressed payload.

ExpansionLimitExceeded

Decompressed output would exceed the caller’s configured expansion limit.

Fields

block_index: u64

Zero-based index of the block that would exceed the limit.

IndexCorrupted(String)

The block index is missing, corrupted, or truncated.

Implementations

impl CrushError

pub fn is_cancelled(&self) -> bool

Returns true if this error represents a user-initiated or programmatic cancellation (distinct from a compression failure).

Trait Implementations

impl Debug for CrushError

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

Formats the value using the given formatter.

impl Display for CrushError

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

Formats the value using the given formatter.

impl Error for CrushError

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 CrushError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<PluginError> for CrushError

fn from(source: PluginError) -> Self

Converts to this type from the input type.

impl From<TimeoutError> for CrushError

fn from(source: TimeoutError) -> Self

Converts to this type from the input type.

impl From<ValidationError> for CrushError

fn from(source: ValidationError) -> Self

Converts to this type from the input type.