Enum ApfsError 

#[non_exhaustive]
pub enum ApfsError {
    Io(Error),
    NoValidSuperblock {
        checked: usize,
        last_magic: u32,
    },
    ChecksumMismatch {
        block: u64,
        stored: u64,
        computed: u64,
    },
    OmapUnresolved {
        oid: u64,
        xid: u64,
    },
    UnexpectedObjectType {
        structure: &'static str,
        expected: u32,
        found: u32,
    },
    UnsupportedFusion,
    UnsupportedSpacemanCab {
        count: u64,
    },
    FieldOutOfRange {
        structure: &'static str,
        field: &'static str,
        value: u64,
        cap: u64,
    },
    CycleGuard {
        cap: usize,
    },
    CheckpointTreeUnsupported {
        area: &'static str,
    },
    SnapshotNotFound {
        xid: u64,
    },
    Decmpfs(&'static str),
}

Errors surfaced by the reader. Bootstrap failures (no valid superblock, omap unresolvable) are loud, named variants — never silently absorbed into an empty result (fleet fail-loud-on-bootstrap rule).

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

Underlying I/O error.

NoValidSuperblock

No valid container superblock (NXSB) found in the checkpoint ring — a bootstrap failure, carries what was seen so the examiner can diagnose.

Fields

checked: usize

last_magic: u32

ChecksumMismatch

Object Fletcher-64 checksum did not validate.

Fields

block: u64

stored: u64

computed: u64

OmapUnresolved

An object map could not resolve a virtual oid at the requested xid.

Fields

oid: u64

xid: u64

UnexpectedObjectType

A block did not carry the expected object type — a short block, a wrong-typed object, or corruption. Carries the offending raw o_type (fleet “show the unrecognized value” rule).

Fields

structure: &'static str

expected: u32

found: u32

UnsupportedFusion

A Fusion container was encountered but Fusion address translation is not yet supported — fail loud rather than mis-read physical addresses.

UnsupportedSpacemanCab

The space manager uses chunk-info address blocks (sm_cab_count > 0), the multi-TB CAB indirection tier, which is not yet implemented — fail loud rather than mis-resolve an allocation chunk. Carries the count.

Fields

count: u64

FieldOutOfRange

A length/offset/count field from the image exceeded a sanity cap (allocation-bomb / corruption defense). Carries the offending value.

Fields

structure: &'static str

field: &'static str

value: u64

cap: u64

CycleGuard

A tree walk exceeded the cycle-guard depth (malicious/cyclic oid graph).

Fields

cap: usize

CheckpointTreeUnsupported

The checkpoint descriptor or data area is stored as a B-tree (high bit of nx_xp_{desc,data}_blocks set), which needs B-tree resolution not yet implemented — fail loud rather than mis-read a tree oid as a base address.

Fields

area: &'static str

SnapshotNotFound

A snapshot mount was requested for a transaction id that names neither the live volume nor any retained snapshot — fail loud with the offending xid rather than silently mounting the wrong (or live) state.

Fields

xid: u64

Decmpfs(&'static str)

A transparently-compressed file’s com.apple.decmpfs payload could not be decoded — a named codec/format failure (unknown/unsupported compression type, malformed header, codec rejection, or a length mismatch). The reader refuses rather than returning plausible-but-wrong bytes (fail-loud: fabricating file content in a forensic tool is the worst failure).

Trait Implementations

impl Debug for ApfsError

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

Formats the value using the given formatter.

impl Display for ApfsError

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

Formats the value using the given formatter.

impl Error for ApfsError

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 ApfsError

fn from(source: Error) -> Self

Converts to this type from the input type.