Enum snap::Error
[−]
[src]
pub enum Error { 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, }, }
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 of TooBig
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 of BufferTooSmall
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 of HeaderMismatch
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 of Literal
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 of CopyRead
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 of CopyWrite
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 of Offset
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 of StreamHeader
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 of StreamHeaderMismatch
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 of UnsupportedChunkType
byte: u8 | The chunk type byte that was read. |
UnsupportedChunkLength
This error occurs when trying to read a chunk with length greater than that supported by this library when reading a Snappy frame formatted stream. This error only occurs when reading a Snappy frame formatted stream.
Fields of UnsupportedChunkLength
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 of Checksum
expected: u32 | The expected checksum read from the stream. |
got: u32 | The computed checksum. |
Trait Implementations
impl Debug for Error
[src]
impl Eq for Error
[src]
impl PartialEq for Error
[src]
This implementation of PartialEq
returns false
when comparing two
errors whose underlying type is std::io::Error
.
fn eq(&self, other: &Error) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0
This method tests for !=
.
impl Error for Error
[src]
fn description(&self) -> &str
A short description of the error. Read more
fn cause(&self) -> Option<&Error>
The lower-level cause of this error, if any. Read more