Struct OpenOptions 

#[non_exhaustive]
pub struct OpenOptions {
    pub auto_orient: bool,
    pub to_srgb: bool,
    pub animated: bool,
    pub limits: Limits,
}

How Image::open_with and Image::from_stream_with read an image.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

auto_orient: bool

Turn the image upright as its metadata declares — EXIF Orientation in JPEG, TIFF and WebP, irot/imir in AVIF — before any op.

On by default (SPEC §Safety and limits): a phone photograph is stored sideways far more often than anyone wants it processed that way. Off, pixels arrive as stored, and Image::orient applies an orientation read some other way.

to_srgb: bool

Convert pixels in an embedded ICC profile’s colour space to sRGB, the space every op and most consumers assume (SPEC §Pixel formats).

On by default, so a Display P3 phone photo or an Adobe RGB export does not come out dull or garish. Off, pixels arrive as stored with the profile attached (Image::icc_profile) and written into the output, and Image::to_srgb converts later. A profile this cannot convert is kept either way.

animated: bool

Ask for every frame of an animated image rather than the first.

Reserved for the multi-frame pipeline, which is not implemented yet: set, opening an animated GIF or WebP fails with PixelsError::Unsupported rather than quietly processing one frame, so code written against it today states its intent and starts working when frames do. Off by default, as in sharp: the first frame is the image, and Image::animation says what was left out.

limits: Limits

Bounds on what a file may make the decoder allocate. A runtime facing untrusted uploads sets these per request; the default refuses images over 268 megapixels, as sharp does.

Implementations

impl OpenOptions

pub const fn with_auto_orient(self, auto_orient: bool) -> Self

The defaults with auto_orient replaced.

OpenOptions is #[non_exhaustive], so outside this crate a setter is the only way to change a field.

pub const fn with_animated(self, animated: bool) -> Self

The defaults with animated replaced.

pub const fn with_limits(self, limits: Limits) -> Self

The defaults with limits replaced.

pub const fn with_to_srgb(self, to_srgb: bool) -> Self

The defaults with to_srgb replaced.

Trait Implementations

impl Clone for OpenOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OpenOptions

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for OpenOptions

impl PartialEq for OpenOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OpenOptions