Enum image::ImageFormat

source · [−]

pub enum ImageFormat {
Show 13 variants    Png,
    Jpeg,
    Gif,
    WebP,
    Pnm,
    Tiff,
    Tga,
    Dds,
    Bmp,
    Ico,
    Hdr,
    Farbfeld,
    Avif,
    // some variants omitted
}

Expand description

An enumeration of supported image formats. Not all formats support both encoding and decoding.

Variants

`Png`

An Image in PNG Format

`Jpeg`

An Image in JPEG Format

`Gif`

An Image in GIF Format

`WebP`

An Image in WEBP Format

`Pnm`

An Image in general PNM Format

`Tiff`

An Image in TIFF Format

`Tga`

An Image in TGA Format

`Dds`

An Image in DDS Format

`Bmp`

An Image in BMP Format

`Ico`

An Image in ICO Format

`Hdr`

An Image in Radiance HDR Format

`Farbfeld`

An Image in farbfeld Format

`Avif`

An Image in AVIF format.

Implementations

impl ImageFormat

pub fn from_extension<S>(ext: S) -> Option<Self> where
S: AsRef<OsStr>,

Return the image format specified by a path’s file extension.

Example

use image::ImageFormat;

let format = ImageFormat::from_extension("jpg");
assert_eq!(format, Some(ImageFormat::Jpeg));

pub fn from_path<P>(path: P) -> ImageResult<Self> where
P: AsRef<Path>,

Return the image format specified by the path’s file extension.

Example

use image::ImageFormat;

let format = ImageFormat::from_path("images/ferris.png")?;
assert_eq!(format, ImageFormat::Png);

pub fn can_read(&self) -> bool

Return if the ImageFormat can be decoded by the lib.

pub fn can_write(&self) -> bool

Return if the ImageFormat can be encoded by the lib.

pub fn extensions_str(self) -> &'static [&'static str ]

Return a list of applicable extensions for this format.

All currently recognized image formats specify at least on extension but for future compatibility you should not rely on this fact. The list may be empty if the format has no recognized file representation, for example in case it is used as a purely transient memory format.

The method name extensions remains reserved for introducing another method in the future that yields a slice of OsStr which is blocked by several features of const evaluation.

Trait Implementations

impl Clone for ImageFormat

fn clone(&self) -> ImageFormat

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for ImageFormat

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

Formats the value using the given formatter. Read more

impl From<ImageFormat> for ImageFormatHint

fn from(format: ImageFormat) -> Self

Performs the conversion.

impl From<ImageFormat> for ImageOutputFormat

fn from(fmt: ImageFormat) -> Self

Performs the conversion.

impl Hash for ImageFormat

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<ImageFormat> for ImageFormat

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl Copy for ImageFormat

impl Eq for ImageFormat

impl StructuralEq for ImageFormat

impl StructuralPartialEq for ImageFormat

Auto Trait Implementations

impl RefUnwindSafe for ImageFormat

impl Send for ImageFormat

impl Sync for ImageFormat

impl Unpin for ImageFormat

impl UnwindSafe for ImageFormat

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.