Enum Error 

pub enum Error {
    InvalidHexCode(String),
    InvalidPaletteIndex,
    InvalidExtension(OsString),
    EncodingError(String),
    DecodingError(String),
    FontError(&'static str),
    UnknownEncodingFormat,
    IncompatibleImageData {
        width: u32,
        height: u32,
        received: usize,
    },
    UnsupportedColorType,
    IoError(Error),
    EmptyImageError,
    QuantizationOverflow {
        unique_colors: usize,
        palette_size: usize,
    },
}

Represents an error that occurs within the crate.

Variants

InvalidHexCode(String)

An invalid hex code was provided when trying to parse a hex value.

InvalidPaletteIndex

Received an invalid palette index.

InvalidExtension(OsString)

An invalid extension was provided when trying to resolve an image’s encoding format from a file extension.

Note

This is not an error that occurs when the file extension is not recognized, or is an unknown image extension. This occurs if the OsStr fails conversion to a native &str. In the case of this, [ImageFormat::Unknown] is used instead.

EncodingError(String)

Failed to encode an image.

DecodingError(String)

Invalid data was encountered when an image, usually because it is corrupted.

Errors can differ across encodings, so the inner &'static str here is nothing more than an error message.

FontError(&'static str)

An error occured while trying to render or rasterize a font.

UnknownEncodingFormat

No encoding format could be inferred for the given image.

IncompatibleImageData

An image received data incompatible with the image’s dimensions.

Fields

width: u32

height: u32

received: usize

UnsupportedColorType

Received an unsupported color type when trying to create a pixel from raw data.

This occurs when the color type is not supported by the pixel type. This is almost always fixed by switching the pixel type to [Dynamic] then using [Image::convert] to convert the image into your desired type.

IoError(Error)

An error occured when trying to read a file or when trying to write to a file.

EmptyImageError

Tried to encode an empty image, or an image without data. This is also raised when trying to encode an image sequence with no frames.

QuantizationOverflow

Attempted lossless quantization, but there are more unique colors than the desired palette size.

Fields

unique_colors: usize

The amount of unique colors in the image.

palette_size: usize

The desired palette size.

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, f: &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<DecodingError> for Error

Available on crate feature png only.

fn from(err: DecodingError) -> Self

Converts to this type from the input type.

impl From<DecodingError> for Error

Available on crate feature gif only.

fn from(err: DecodingError) -> Self

Converts to this type from the input type.

impl From<EncodingError> for Error

Available on crate feature png only.

fn from(err: EncodingError) -> Self

Converts to this type from the input type.

impl From<EncodingError> for Error

Available on crate feature jpeg only.

fn from(err: EncodingError) -> Self

Converts to this type from the input type.

impl From<EncodingError> for Error

Available on crate feature gif only.

fn from(err: EncodingError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature jpeg only.

fn from(err: Error) -> Self

Converts to this type from the input type.