Enum Error 

#[non_exhaustive]
pub enum Error {
    UnsupportedFormat(String),
    UnsupportedCompression {
        format: &'static str,
        compression: String,
    },
    #[non_exhaustive]
    CorruptFile {
        what: String,
        offset: Option<u64>,
        reason: Option<Box<CorruptReason>>,
    },
    InvalidMetadata(String),
    CameraUnsupported {
        make: String,
        model: String,
        reason: String,
    },
    GpuUnavailable(String),
    OutOfMemory(String),
    LimitExceeded(String),
    NotAvailable(String),
    InvalidArgument(String),
    Io(Error),
}

All errors produced while parsing or decoding a RAW file.

Errors carry enough context (format, offset, what was being parsed) to make a failure on a corpus file actionable without a debugger.

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.

UnsupportedFormat(String)

The bytes do not look like any RAW format FlashRaw understands.

UnsupportedCompression

The container was understood but the payload uses an unsupported compression scheme.

Fields

format: &'static str

Container format name (e.g. "NEF").

compression: String

Description of the compression scheme.

#[non_exhaustive]

CorruptFile

The file is structurally invalid (truncated, bad offsets, corrupt entropy data…).

Truncated sensor data carries a structured CorruptReason (see Error::corrupt_reason and Error::truncation).

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

what: String

What was being parsed or what was wrong.

offset: Option<u64>

Byte offset in the input where the problem was found, when known.

reason: Option<Box<CorruptReason>>

Structured cause, when known (e.g. which strip is truncated and by how much).

InvalidMetadata(String)

Metadata required for decoding is missing or nonsensical.

CameraUnsupported

The file format is supported but this camera or mode is not (yet).

Fields

make: String

Camera make.

model: String

Camera model.

reason: String

Why the camera or mode is unsupported (may be empty).

GpuUnavailable(String)

A GPU backend was requested but is not available.

OutOfMemory(String)

An allocation would exceed configured limits or failed.

LimitExceeded(String)

Image dimensions or other values exceed configured safety limits.

NotAvailable(String)

The requested operation is not possible for this file (e.g. no preview, no tiles).

InvalidArgument(String)

Invalid caller-provided arguments (bad region, incompatible options…).

Io(Error)

I/O failure while reading input.

Implementations

impl Error

pub fn corrupt(what: impl Display) -> Self

Shorthand for a Error::CorruptFile without an offset.

pub fn corrupt_at(what: impl Display, offset: u64) -> Self

Shorthand for a Error::CorruptFile with an offset.

pub fn truncated(t: Truncation) -> Self

A Error::CorruptFile for sensor data that extends past the end of the input.

pub fn corrupt_with(reason: CorruptReason) -> Self

A Error::CorruptFile with a structured reason.

pub fn or_truncated( self, file_len: usize, unit: DataUnit, offset: usize, declared: usize, ) -> Self

Attribute a failure to decode a compressed range to truncation when that range (declared bytes at offset) runs past the end of a file_len-byte input: the error becomes a structured CorruptReason::Truncated report. Other errors, and ranges inside the file, are returned unchanged. (Compressed streams are only known to be short when the decoder runs out of data, so the range is not checked up front.)

pub fn corrupt_reason(&self) -> Option<&CorruptReason>

The structured cause of a Error::CorruptFile, when known.

pub fn truncation(&self) -> Option<&Truncation>

Details of truncated sensor data (a CorruptReason::Truncated corruption).

pub fn invalid_metadata(what: impl Display) -> Self

Shorthand for an Error::InvalidMetadata.

pub fn unsupported_compression( format: &'static str, compression: impl Display, ) -> Self

Shorthand for an Error::UnsupportedCompression.

pub fn kind(&self) -> &'static str

Short machine-friendly classification, used by the CLI’s JSON output and the JS bindings.

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.