Skip to main content

DecodeOptions

rawshift_image::formats

Enum DecodeOptions

#[non_exhaustive]pub enum DecodeOptions {
    JpegZune(ZuneJpegDecodeConfig),
    PngZune(ZunePngDecodeConfig),
    WebpLibwebp(LibwebpDecodeConfig),
    JxlOxide(JxlOxideDecodeConfig),
    Gif(GifDecodeConfig),
    Tiff(TiffDecodeConfig),
    AvifImage(ImageAvifDecodeConfig),
    HeicLibheif(LibheifDecodeConfig),
    SvgResvg(ResvgDecodeConfig),
    PpmZune(ZunePpmDecodeConfig),
}

Expand description

Selects which decoder implementation handles a standard image, and carries that implementation’s configuration.

Each variant pairs a compressed format with one backend library. rawshift can be built with multiple implementations of the same format enabled (see the implementation feature flags in the crate documentation); this enum is how a caller pins exactly which one decode_standard_image_with uses.

Use DecodeOptions::default_for to obtain the default backend for a format. RAW formats are intentionally absent — they have a single in-repo implementation and are decoded through RawFile.

Variants (Non-exhaustive)§

This enum is marked as 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.

JpegZune(ZuneJpegDecodeConfig)

JPEG via zune-jpeg.

PngZune(ZunePngDecodeConfig)

PNG via zune-png.

WebpLibwebp(LibwebpDecodeConfig)

WebP via libwebp.

JxlOxide(JxlOxideDecodeConfig)

JPEG XL via jxl-oxide.

Gif(GifDecodeConfig)

GIF via the gif crate.

Tiff(TiffDecodeConfig)

TIFF via the tiff crate.

AvifImage(ImageAvifDecodeConfig)

AVIF via image (avif-native).

HeicLibheif(LibheifDecodeConfig)

HEIC/HEIF via libheif.

SvgResvg(ResvgDecodeConfig)

SVG via resvg.

PpmZune(ZunePpmDecodeConfig)

PPM / Netpbm via zune-ppm.

Implementations§

impl DecodeOptions

pub fn format(&self) -> StandardFormat

The standard format this backend decodes.

pub fn codec_id(&self) -> CodecId

The stable identifier of the selected decoder implementation.

pub fn default_for(format: StandardFormat) -> Option<DecodeOptions>

The default decoder backend for format, with default configuration.

Returns None when no decoder for format is compiled in (the relevant feature flag is disabled, or the format has no decoder — e.g. APV).

Trait Implementations§

impl Clone for DecodeOptions

fn clone(&self) -> DecodeOptions

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for DecodeOptions

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for DecodeOptions

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for DecodeOptions

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

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

1.0.0 (const: unstable) · Source§

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 Serialize for DecodeOptions

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for DecodeOptions

Auto Trait Implementations§

impl Freeze for DecodeOptions

impl RefUnwindSafe for DecodeOptions

impl Send for DecodeOptions

impl Sync for DecodeOptions

impl Unpin for DecodeOptions

impl UnsafeUnpin for DecodeOptions

impl UnwindSafe for DecodeOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

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> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

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.

fn to_owned(&self) -> T

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

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

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.

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.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,