Enum fog_pack::Error

pub enum Error {
    SchemaMismatch,
    BadHeader,
    FailDecompress,
    BadSize,
    BadSignature,
    BadEncode(usize, &'static str),
    FailValidate(usize, &'static str),
    CryptoError(CryptoError),
    ParseLimit(usize, &'static str),
    Io(Error),
}

Possible fog-pack error conditions.

Variants

SchemaMismatch

Occurs when a schema doesn't match the document's schema, a Schema was used when one isn't specified by the document, or a NoSchema was used when a document specified a schema.

BadHeader

Occurs when the header (compression marker and optional schema) failed to parse correctly.

FailDecompress

Occurs when zstd compression fails, possibly due to a dictionary not being present in a schema, a checksum failing, or and of the other zstd failure modes.

BadSize

Document/Entry/Query was greater than maximum allowed size on decode

BadSignature

Signature attached to end of Document/Entry/Query didn't validate

BadEncode(usize, &'static str)

Basic fog-pack encoding failure, with reason string and remaining bytes in buffer when error occurred.

FailValidate(usize, &'static str)

Schema validation failure, with reason string and remaining bytes in buffer when error occurred. Also occurs when parsing a Schema or Query and it doesn't fit the accepted format.

CryptoError(CryptoError)

Failure within the cryptographic submodule.

ParseLimit(usize, &'static str)

Schema or validation hit some parsing limit, with reason string and remaining bytes in buffer when error occurred.

Io(Error)

Propagated I/O error. Generally occurs when end of buffer was reached before the decoder expected it, meaning the Document/Entry/Query is likely incomplete.

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)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<CryptoError> for Error

fn from(err: CryptoError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Error

Performs the conversion.