Enum BtrfsError 

#[non_exhaustive]
pub enum BtrfsError {
    Truncated {
        structure: &'static str,
        need: usize,
        have: usize,
    },
    BadMagic {
        bytes: [u8; 8],
    },
    AllocationBomb {
        field: &'static str,
        claimed: u64,
        bound: u64,
    },
}

Errors surfaced while parsing btrfs on-disk structures.

Every variant names the offending value so an “unknown/invalid” report hands the investigator the evidence (raw bytes / offset), never a bare “invalid”.

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.

Truncated

The buffer was too small to hold the structure being parsed.

Fields

structure: &'static str

Name of the structure that could not be read.

need: usize

Minimum byte length required.

have: usize

Byte length actually available.

BadMagic

The superblock magic did not match _BHRfS_M at offset 0x40.

Carries the eight bytes actually found so the caller can identify what the image really is (fail-loud with the offending value).

Fields

bytes: [u8; 8]

The eight raw bytes read at superblock offset 0x40.

AllocationBomb

A length/size field from the untrusted image demanded an allocation far larger than the image itself could justify — a classic allocation-bomb.

Carries the offending value and the bound it exceeded so the report hands the investigator the evidence, never a bare “too big” (fail-loud).

Fields

field: &'static str

The name of the length field that overflowed the bound.

claimed: u64

The absurd byte count the image field claimed.

bound: u64

The largest value that could be legitimate (e.g. the image length).

Trait Implementations

impl Debug for BtrfsError

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

Formats the value using the given formatter.

impl Display for BtrfsError

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

Formats the value using the given formatter.

impl Eq for BtrfsError

impl Error for BtrfsError

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 PartialEq for BtrfsError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BtrfsError