Skip to main content

EncodeOptions

Enum EncodeOptions 

Source
#[non_exhaustive]
pub enum EncodeOptions { PngZune(ZunePngEncodeConfig), JpegJpegEnc(JpegEncEncodeConfig), WebpLibwebp(LibwebpEncodeConfig), AvifRavif(RavifEncodeConfig), JxlZune(ZuneJxlEncodeConfig), Dng(DngExportConfig), }
Expand description

Selects the encoder implementation and carries its configuration.

Obtain one with EncodeOptions::default_for for a format’s default backend, or with a constructor such as EncodeOptions::jpeg, or by naming a variant directly to pin a specific backend.

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.
§

PngZune(ZunePngEncodeConfig)

PNG via zune-png (requires png-encode).

§

JpegJpegEnc(JpegEncEncodeConfig)

JPEG via the pure-Rust jpeg-encoder (requires jpeg-encode).

§

WebpLibwebp(LibwebpEncodeConfig)

WebP via libwebp (requires webp-encode).

§

AvifRavif(RavifEncodeConfig)

AVIF via ravif / rav1e (requires avif-encode).

§

JxlZune(ZuneJxlEncodeConfig)

JPEG XL via zune-jpegxl (requires jxl-encode).

§

Dng(DngExportConfig)

DNG via the in-repo encoder (requires dng-encode).

Implementations§

Source§

impl EncodeOptions

Source

pub fn png() -> Self

PNG with default configuration.

Source

pub fn jpeg() -> Self

JPEG with default configuration.

Source

pub fn webp_lossy() -> Self

Lossy WebP with default configuration.

Source

pub fn webp_lossless() -> Self

Lossless WebP with default configuration.

Source

pub fn avif() -> Self

AVIF with default configuration.

Source

pub fn jxl() -> Self

JPEG XL with default configuration.

Source

pub fn dng() -> Self

DNG with default configuration.

Source

pub fn format(&self) -> OutputFormat

The output format this encoder produces.

Source

pub fn codec_id(&self) -> CodecId

The stable identifier of the selected encoder implementation.

Source

pub fn common(&self) -> CommonEncodeOptions

The encoder-agnostic options (metadata embedding, bit depth) in effect.

For DNG — which has its own configuration shape — a CommonEncodeOptions is synthesised from DngExportConfig.

Source

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

The default encoder backend for format, with default configuration.

Returns None when no encoder for format is compiled in, or when the format has no encoder. DNG is absent — it is not a StandardFormat; use EncodeOptions::dng.

Trait Implementations§

Source§

impl Clone for EncodeOptions

Source§

fn clone(&self) -> EncodeOptions

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
Source§

impl Debug for EncodeOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EncodeOptions

Available on crate feature png-encode only.
Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for EncodeOptions

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for EncodeOptions

Source§

fn eq(&self, other: &EncodeOptions) -> 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.
Source§

impl Serialize for EncodeOptions

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EncodeOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T, Ctx> BundleDefault<Ctx> for T
where T: Default,

Source§

fn default_with_context(_: Ctx) -> T

Creates a default value with the given context.
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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