snap

Enum Error

Source
pub enum Error {
Show 14 variants TooBig { given: u64, max: u64, }, BufferTooSmall { given: u64, min: u64, }, Empty, Header, HeaderMismatch { expected_len: u64, got_len: u64, }, Literal { len: u64, src_len: u64, dst_len: u64, }, CopyRead { len: u64, src_len: u64, }, CopyWrite { len: u64, dst_len: u64, }, Offset { offset: u64, dst_pos: u64, }, StreamHeader { byte: u8, }, StreamHeaderMismatch { bytes: Vec<u8>, }, UnsupportedChunkType { byte: u8, }, UnsupportedChunkLength { len: u64, header: bool, }, Checksum { expected: u32, got: u32, },
}
Expand description

Error describes all the possible errors that may occur during Snappy compression or decompression.

Note that it’s unlikely that you’ll need to care about the specific error reported since all of them indicate a corrupt Snappy data or a limitation that cannot be worked around. Therefore, From<snap::Error> for std::io::Error is provided so that any Snappy errors will be converted to a std::io::Error automatically when using try!.

Variants§

§

TooBig

This error occurs when the given input is too big. This can happen during compression or decompression.

Fields

§given: u64

The size of the given input.

§max: u64

The maximum allowed size of an input buffer.

§

BufferTooSmall

This error occurs when the given buffer is too small to contain the maximum possible compressed bytes or the total number of decompressed bytes.

Fields

§given: u64

The size of the given output buffer.

§min: u64

The minimum size of the output buffer.

§

Empty

This error occurs when trying to decompress a zero length buffer.

§

Header

This error occurs when an invalid header is found during decompression.

§

HeaderMismatch

This error occurs when there is a mismatch between the number of decompressed bytes reported in the header and the number of actual decompressed bytes. In this error case, the number of actual decompressed bytes is always less than the number reported in the header.

Fields

§expected_len: u64

The total number of decompressed bytes expected (i.e., the header value).

§got_len: u64

The total number of actual decompressed bytes.

§

Literal

This error occurs during decompression when there was a problem reading a literal.

Fields

§len: u64

The expected length of the literal.

§src_len: u64

The number of remaining bytes in the compressed bytes.

§dst_len: u64

The number of remaining slots in the decompression buffer.

§

CopyRead

This error occurs during decompression when there was a problem reading a copy.

Fields

§len: u64

The expected length of the copy (as encoded in the compressed bytes).

§src_len: u64

The number of remaining bytes in the compressed bytes.

§

CopyWrite

This error occurs during decompression when there was a problem writing a copy to the decompression buffer.

Fields

§len: u64

The length of the copy (i.e., the total number of bytes to be produced by this copy in the decompression buffer).

§dst_len: u64

The number of remaining bytes in the decompression buffer.

§

Offset

This error occurs during decompression when an invalid copy offset is found. An offset is invalid if it is zero or if it is out of bounds.

Fields

§offset: u64

The offset that was read.

§dst_pos: u64

The current position in the decompression buffer. If the offset is non-zero, then the offset must be greater than this position.

§

StreamHeader

This error occurs when a stream header chunk type was expected but got a different chunk type. This error only occurs when reading a Snappy frame formatted stream.

Fields

§byte: u8

The chunk type byte that was read.

§

StreamHeaderMismatch

This error occurs when the magic stream headers bytes do not match what is expected. This error only occurs when reading a Snappy frame formatted stream.

Fields

§bytes: Vec<u8>

The bytes that were read.

§

UnsupportedChunkType

This error occurs when an unsupported chunk type is seen. This error only occurs when reading a Snappy frame formatted stream.

Fields

§byte: u8

The chunk type byte that was read.

§

UnsupportedChunkLength

This error occurs when trying to read a chunk with an unexpected or incorrect length when reading a Snappy frame formatted stream. This error only occurs when reading a Snappy frame formatted stream.

Fields

§len: u64

The length of the chunk encountered.

§header: bool

True when this error occured while reading the stream header.

§

Checksum

This error occurs when a checksum validity check fails. This error only occurs when reading a Snappy frame formatted stream.

Fields

§expected: u32

The expected checksum read from the stream.

§got: u32

The computed checksum.

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Error

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for Error

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

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. Read more
Source§

impl From<Error> for Error

Source§

fn from(err: Error) -> Error

Converts to this type from the input type.
Source§

impl PartialEq for Error

Source§

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.