Enum UfsError 

#[non_exhaustive]
pub enum UfsError {
    Truncated {
        structure: &'static str,
        need: usize,
        have: usize,
    },
    BadMagic {
        offset: usize,
        bytes: [u8; 4],
        le: u32,
        be: u32,
    },
    BadCgMagic {
        found: u32,
        endian: Endian,
    },
    ImpossibleGeometry {
        field: &'static str,
        value: u64,
        limit: u64,
    },
    InodeOutOfRange {
        ino: u64,
        count: u64,
    },
}

Errors surfaced while parsing UFS/FFS 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 matched neither UFS1 (0x00011954) nor UFS2 (0x19540119) in either byte order.

Carries the four bytes actually found at the magic offset in both interpretations so the caller can identify what the image really is (fail-loud with the offending value).

Fields

offset: usize

Byte offset within the parsed buffer where the magic was read.

bytes: [u8; 4]

The four raw bytes at the magic offset.

le: u32

The value interpreted little-endian.

be: u32

The value interpreted big-endian.

BadCgMagic

A cylinder-group header’s magic did not match CG_MAGIC (0x00090255).

Carries the value found and the byte order used, so the caller sees the evidence rather than a bare “invalid cg”.

Fields

found: u32

The 32-bit value read at the cg magic offset.

endian: Endian

The byte order used to read it (from the superblock).

ImpossibleGeometry

A geometry field carried a value outside any sane bound for the image — consistent with corruption or an allocation-bomb. Names the field, the value, and the bound so the caller sees exactly what was rejected.

Fields

field: &'static str

The geometry field that was out of range.

value: u64

The value read from the image.

limit: u64

The sane bound it exceeded.

InodeOutOfRange

The requested inode number is past the filesystem’s inode count (fs_ipg * fs_ncg), so it cannot address a real dinode. Carries the requested number and the exclusive upper bound so the caller sees exactly what was rejected (fail-loud with the offending value).

Fields

ino: u64

The inode number that was requested.

count: u64

The total inode count (fs_ipg * fs_ncg), the exclusive upper bound.

Trait Implementations

impl Debug for UfsError

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

Formats the value using the given formatter.

impl Display for UfsError

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

Formats the value using the given formatter.

impl Eq for UfsError

impl Error for UfsError

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 UfsError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UfsError