Enum ImageFormat 

pub enum ImageFormat {
    Unknown,
    Png,
    Jpeg,
    Gif,
    Bmp,
    Tiff,
    WebP,
}

Represents the underlying encoding format of an image.

Variants

Unknown

No known encoding is known for the image.

This is usually because the image was created manually. See Image::set_format to manually set the encoding format.

Png

The image is encoded in the PNG format.

Jpeg

The image is encoded in the JPEG format.

Gif

The image is encoded in the GIF format.

Bmp

The image is encoded in the BMP format.

Tiff

The image is encoded in the TIFF format.

WebP

The image is encoded in the WebP format.

Implementations

impl ImageFormat

pub fn is_unknown(&self) -> bool

Returns whether the extension is unknown.

pub fn from_extension(ext: impl AsRef<OsStr>) -> Result<ImageFormat, Error>

Parses the given extension and returns the corresponding image format.

If the extension is an unknown extension, Ok(ImageFormat::Unknown) is returned.

If the extension is completely invalid and fails to be converted into a &str, the InvalidExtension error is returned.

Errors

• The extension is completely invalid and failed to be converted into a &str.

pub fn from_path(path: impl AsRef<Path>) -> Result<ImageFormat, Error>

Returns the format specified by the given path.

This uses ImageFormat::from_extension to parse the extension.

This resolves via the extension of the path. See ImageFormat::infer_encoding for an implementation that can resolve the format from the data.

Errors

• No extension can be resolved from the path.

pub fn from_mime_type(mime: impl AsRef<str>) -> ImageFormat

Returns the format specified by the given MIME type.

pub fn infer_encoding(sample: &[u8]) -> ImageFormat

Infers the encoding format from the given data via a byte stream.

pub fn run_encoder<P>( &self, image: &Image<P>, dest: impl Write, ) -> Result<(), Error>

where P: Pixel,

Encodes the Image into raw bytes.

Errors

• An error occured while encoding.

Panics

• No encoder implementation is found for this image encoding.

pub fn run_sequence_encoder<P>( &self, seq: &ImageSequence<P>, dest: impl Write, ) -> Result<(), Error>

where P: Pixel,

Encodes the ImageSequence into raw bytes. If the encoding does not supported image sequences (or multi-frame images), it will only encode the first frame.

Errors

• An error occured while encoding.

Panics

• No encoder implementation is found for this image encoding.

pub fn run_decoder<P>(&self, stream: impl Read) -> Result<Image<P>, Error>

where P: Pixel,

Decodes the image data from into an image.

Errors

• An error occured while decoding.

Panics

• No decoder implementation is found for this image encoding.

pub fn run_sequence_decoder<'a, P, R>( &self, stream: R, ) -> Result<Box<dyn FrameIterator<P, Item = Result<Frame<P>, Error>> + 'a>, Error>

where P: Pixel + 'a, R: Read + 'a,

Decodes the image sequence data into an image sequence.

Errors

• An error occured while decoding.

Panics

• No decoder implementation is found for this image encoding.

Trait Implementations

impl Clone for ImageFormat

fn clone(&self) -> ImageFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageFormat

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

Formats the value using the given formatter.

impl Default for ImageFormat

fn default() -> ImageFormat

Returns the “default value” for a type.

impl Display for ImageFormat

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

Formats the value using the given formatter.

impl Hash for ImageFormat

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ImageFormat

fn eq(&self, other: &ImageFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ImageFormat

impl Eq for ImageFormat

impl StructuralPartialEq for ImageFormat