Enum Error 

#[non_exhaustive]
pub enum Error {
    BwtFailed,
    ChecksumMismatch,
    CorruptStageData,
    InvalidMagic,
    TruncatedHeader,
    InvalidHeader,
    TruncatedData,
    BlockTooLarge,
    BufferTooSmall,
    OutputSizeMismatch,
    OutOfMemory,
    InvalidBlockSize,
    ThreadPoolFailed,
    Io(Error),
}

Every failure mode of the bzip3 port.

Ten variants keep the C reference codes. Four variants have no reference code. OutOfMemory, InvalidBlockSize, and ThreadPoolFailed split the old reference init error. Io is produced only by the streaming wrappers when a read or write fails. Some reference codes map to more than one variant. Use Error::code to get the reference code.

The enum is #[non_exhaustive]. A match needs a wildcard arm.

Examples

use bzip3_rs::decompress;
use bzip3_rs::error::Error;

match decompress(&[0_u8; 13]) {
    Ok(_) => unreachable!("zero bytes are not a frame"),
    Err(Error::InvalidMagic) => {}
    Err(other) => panic!("unexpected error: {other}"),
}

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.

BwtFailed

Burrows-Wheeler transform failed (reference code -2).

ChecksumMismatch

Checksum of the decoded block does not match (reference code -3).

CorruptStageData

RLE or LZP data is corrupt (reference code -3).

InvalidMagic

Magic number is wrong (reference code -4).

TruncatedHeader

Header is shorter than its fixed size (reference code -4).

InvalidHeader

Header field is out of range or inconsistent (reference code -4).

TruncatedData

Data ends before the end of a payload (reference code -5).

BlockTooLarge

Block too large (reference code -6).

BufferTooSmall

Payload is larger than the decode buffer (reference code -8).

OutputSizeMismatch

Output buffer length is not the original block size (reference code -8).

OutOfMemory

Working memory allocation failed. No reference code.

InvalidBlockSize

Block size outside the valid range. No reference code.

ThreadPoolFailed

Private thread pool build failed. No reference code.

Io(Error)

Read or write failure inside a streaming wrapper. No reference code.

Implementations

impl Error

pub const fn code(&self) -> Option<i32>

Numeric reference code (-2 to -8).

Returns None for variants with no reference code.

Examples

use bzip3_rs::error::Error;

assert_eq!(Error::InvalidMagic.code(), Some(-4));
assert_eq!(Error::InvalidBlockSize.code(), None);

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(e: Error) -> Self

Converts to this type from the input type.