Enum BcfError 

#[non_exhaustive]
pub enum BcfError {
    Io {
        path: Option<PathBuf>,
        source: Error,
    },
    NotAnArchive {
        detail: String,
    },
    NoTopics,
    LimitExceeded {
        limit: &'static str,
        allowed: u64,
        requested: u64,
    },
    UnsafeEntry {
        name: String,
    },
}

A failure that prevents reading a BCF archive.

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

The file could not be opened or read.

Fields

path: Option<PathBuf>

The path involved, when one is known.

source: Error

The underlying I/O failure.

NotAnArchive

The bytes are not a readable ZIP container.

Fields

detail: String

What the ZIP reader reported.

NoTopics

The archive contains no markup document, so there is no BCF content.

Distinguished from an archive with unreadable topics: that yields diagnostics and whatever parsed, while this means the container held nothing recognisable as BCF at all.

LimitExceeded

A declared limit in Limits was exceeded.

BCF archives arrive from untrusted parties, so decompression is bounded rather than trusted. This is refusal, not corruption.

Fields

limit: &'static str

Which limit tripped.

allowed: u64

The bound that was set.

requested: u64

What the archive asked for, when it is known up front.

UnsafeEntry

An archive entry escapes the extraction root, or is otherwise unsafe.

Kept fatal on purpose: a traversal path is not a tolerable quirk, it is an attempt to write outside the archive.

Fields

name: String

The offending entry name, verbatim.

Trait Implementations

impl Debug for BcfError

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

Formats the value using the given formatter.

impl Display for BcfError

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

Formats the value using the given formatter.

impl Error for BcfError

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 BcfError

fn from(source: Error) -> Self

Converts to this type from the input type.