Enum Error

#[non_exhaustive]
pub enum Error {
    Io(Error),
    Fse(FseErrorKind),
    Vn(VnErrorKind),
    BadBlock(u32),
    BadBitStream,
    BadDValue,
    BadReaderState,
    BufferOverflow,
    PayloadOverflow,
    PayloadUnderflow,
}

Decoding errors.

You may want to convert Error to io::Error either directly or by using the ? operator, see the examples below. Reporting information is preserved across the conversion. Error::Io errors are flattened whilst other errors are boxed into an InvalidData variant io::Error.

Examples

use std::io;

// Direct conversion
pub fn decode(src: &[u8], dst: &mut Vec<u8>) -> io::Result<u64> {
    lzfse_rust::decode_bytes(src, dst).map_err(Into::into)
}

use std::io;

// `?` operator conversion
pub fn decode(src: &[u8], dst: &mut Vec<u8>) -> io::Result<()> {
    lzfse_rust::decode_bytes(src, dst)?;
    Ok(())
}

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.

Io(Error)

IO errors.

Fse(FseErrorKind)

FSE specific errors.

Vn(VnErrorKind)

VN specific errors.

BadBlock(u32)

Unknown or unsupported block type (magic bytes).

BadBitStream

Bad bitstream.

BadDValue

Bad LZ distance value.

BadReaderState

Reader state is invalid, likely the user attempted to use after an error was encountered.

BufferOverflow

Buffer overflow.

PayloadOverflow

Input has more bytes than expected.

PayloadUnderflow

Input has less bytes than expected.

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<(), Error>

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(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FseErrorKind> for Error

fn from(err: FseErrorKind) -> Error

Converts to this type from the input type.

impl From<VnErrorKind> for Error

fn from(err: VnErrorKind) -> Error

Converts to this type from the input type.