Enum PixelsError 

#[non_exhaustive]
pub enum PixelsError {
    Io {
        context: &'static str,
        source: Error,
    },
    Malformed {
        format: &'static str,
        detail: String,
    },
    Unsupported {
        detail: String,
    },
    LimitExceeded {
        limit: Limit,
        requested: u64,
        allowed: u64,
    },
    InvalidArgument {
        parameter: &'static str,
        detail: String,
    },
    Graph {
        detail: String,
    },
}

The error type returned by every fallible engine operation.

Construct these with the associated helpers (PixelsError::malformed, PixelsError::unsupported, …) rather than the variants directly, so that added fields stay non-breaking.

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

A source read or sink write failed.

Fields

context: &'static str

What the engine was doing when the I/O failed.

source: Error

The underlying operating system error.

Malformed

Input bytes are invalid for their format.

Every codec parser returns this instead of panicking, for any input.

Fields

format: &'static str

The format being parsed, e.g. "raw", "png".

detail: String

What was wrong, in human-readable terms.

Unsupported

A recognized format or feature that is not implemented.

Fields

detail: String

What is unsupported, in human-readable terms.

LimitExceeded

A safety limit was exceeded before any pixel allocation.

Fields

limit: Limit

Which limit was hit.

requested: u64

The value the input asked for.

allowed: u64

The configured maximum.

InvalidArgument

A caller-supplied argument is invalid.

Fields

parameter: &'static str

The parameter at fault, e.g. "width".

detail: String

Why it is invalid.

Graph

The op graph cannot be evaluated as constructed.

Fields

detail: String

Why the graph is invalid.

Implementations

impl PixelsError

pub const fn code(&self) -> ErrorCode

The stable classification of this error.

pub fn io(context: &'static str, source: Error) -> PixelsError

Wrap an I/O error with the engine context it happened in.

pub fn malformed(format: &'static str, detail: impl Into<String>) -> PixelsError

Report input bytes that are invalid for format.

pub fn unsupported(detail: impl Into<String>) -> PixelsError

Report a recognized but unimplemented format or feature.

pub fn invalid_argument( parameter: &'static str, detail: impl Into<String>, ) -> PixelsError

Report an invalid caller-supplied argument.

pub fn graph(detail: impl Into<String>) -> PixelsError

Report a graph that cannot be evaluated.

pub const fn limit_exceeded( limit: Limit, requested: u64, allowed: u64, ) -> PixelsError

Report an exceeded safety limit.

Trait Implementations

impl Debug for PixelsError

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

Formats the value using the given formatter.

impl Display for PixelsError

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

Formats the value using the given formatter.

impl Error for PixelsError

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.