Struct Limits 

#[non_exhaustive]
pub struct Limits {
    pub max_pixels: u64,
}

Safety limits applied before any pixel memory is allocated.

See SPEC §Safety. Limits are checked at header parse time, so a hostile header that claims enormous dimensions is rejected before the engine commits memory to it.

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.

max_pixels: u64

Maximum total pixels (width × height) in a single image.

Defaults to Limits::DEFAULT_MAX_PIXELS.

Implementations

impl Limits

pub const DEFAULT_MAX_PIXELS: u64 = 268_402_689

The default max_pixels: 268 megapixels, matching Sharp.

pub const fn unlimited() -> Limits

Limits with every check disabled.

Only appropriate for fully trusted input.

pub const fn with_max_pixels(self, max_pixels: u64) -> Limits

The default limits with max_pixels replaced.

This exists because Limits is #[non_exhaustive]: downstream crates cannot write Limits { max_pixels, .. }, so without a setter the field would be readable but unconfigurable outside this crate.

pub fn check(&self, width: u32, height: u32) -> Result<(), PixelsError>

Check a dimension pair against these limits.

Errors

Returns PixelsError::LimitExceeded if the pixel count exceeds Limits::max_pixels, or PixelsError::InvalidArgument if either dimension is zero.

Trait Implementations

impl Clone for Limits

fn clone(&self) -> Limits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Limits

impl Debug for Limits

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

Formats the value using the given formatter.

impl Default for Limits

fn default() -> Limits

Returns the “default value” for a type.

impl Eq for Limits

impl PartialEq for Limits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Limits