Enum FormatError 

#[non_exhaustive]
pub enum FormatError {
    Io(Error),
    Decode(Box<dyn Error + Send + Sync>),
    Encode {
        reason: Box<str>,
    },
    Data(Box<DataError>),
    Path(Box<PathParseError>),
}

Error returned by FileFormat::read and FileFormat::write.

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)

Byte I/O against the asset failed (resolver open, read, seek, write).

Decode(Box<dyn Error + Send + Sync>)

The asset’s bytes could not be decoded as this format. Transparent: Display and source are the boxed format error’s own, so a rich decode diagnostic (e.g. a usda parse error’s caret rendering) survives to the caller and stays downcastable. Boxed so sdf stays below the concrete formats and external FileFormat implementors can report their own decode errors.

Encode

The data holds something this format cannot encode.

Fields

reason: Box<str>

What could not be encoded.

Data(Box<DataError>)

Reading a field value out of the layer’s data failed while serializing it (a lazy backend could not decode the authored value). Boxed, with Path, to keep the enum small — the assertion below pins it, since this error rides the writers’ per-element loops.

Path(Box<PathParseError>)

A name in the data does not form a valid sdf path while walking the hierarchy for serialization.

Trait Implementations

impl Debug for FormatError

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

Formats the value using the given formatter.

impl Display for FormatError

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

Formats the value using the given formatter.

impl Error for FormatError

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<DataError> for FormatError

fn from(error: DataError) -> Self

Converts to this type from the input type.

impl From<Error> for FormatError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for FormatError

A Display implementation failed while formatting a value into text. fmt::Error carries no detail, so the message is fixed.

fn from(_: Error) -> Self

Converts to this type from the input type.

impl From<FormatError> for Error

fn from(source: FormatError) -> Self

Converts to this type from the input type.

impl From<FormatError> for ExportError

fn from(source: FormatError) -> Self

Converts to this type from the input type.

impl From<PathParseError> for FormatError

fn from(error: PathParseError) -> Self

Converts to this type from the input type.