Struct Limits 

#[non_exhaustive]
pub struct Limits {
    pub max_width: Option<u32>,
    pub max_height: Option<u32>,
    pub max_total_pixels: Option<u64>,
    pub max_frame_count: Option<u64>,
    pub max_file_size: Option<u64>,
    pub max_memory: Option<u64>,
}

Configuration for decode limits.

All limits are optional; None means unlimited.

Example

use zenwebp::Limits;

// Start with defaults and customize
let limits = Limits::default()
    .max_dimensions(4096, 4096)
    .max_memory(256 * 1024 * 1024);  // 256 MB

// Or start with no limits for trusted inputs
let unlimited = Limits::none();

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_width: Option<u32>

Maximum image width in pixels.

max_height: Option<u32>

Maximum image height in pixels.

max_total_pixels: Option<u64>

Maximum total pixels (width * height). Useful for limiting memory even with odd aspect ratios.

max_frame_count: Option<u64>

Maximum number of frames in an animation.

max_file_size: Option<u64>

Maximum input file size in bytes.

max_memory: Option<u64>

Maximum memory usage in bytes during decoding.

Implementations

impl Limits

pub fn none() -> Self

Create limits with no restrictions.

Warning: Only use this for trusted inputs!

pub fn max_dimensions(self, width: u32, height: u32) -> Self

Set maximum dimensions.

pub fn max_total_pixels(self, pixels: u64) -> Self

Set maximum total pixels.

pub fn max_frame_count(self, count: u64) -> Self

Set maximum frame count.

pub fn max_file_size(self, bytes: u64) -> Self

Set maximum file size in bytes.

pub fn max_memory(self, bytes: u64) -> Self

Set maximum memory usage in bytes.

pub fn check_dimensions( &self, width: u32, height: u32, ) -> Result<(), At<DecodeError>>

Check if dimensions are within limits.

pub fn check_frame_count(&self, count: usize) -> Result<(), At<DecodeError>>

Check if frame count is within limits.

pub fn check_file_size(&self, size: u64) -> Result<(), At<DecodeError>>

Check if file size is within limits.

pub fn check_memory(&self, bytes: usize) -> Result<(), At<DecodeError>>

Check if memory usage is within limits.

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 Debug for Limits

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

Formats the value using the given formatter.

impl Default for Limits

fn default() -> Self

Default limits suitable for server-side use.

• Max dimensions: 16384 x 16384 (WebP format max)
• Max total pixels: 100 megapixels
• Max frames: 10,000
• Max file size: 100 MB
• Max memory: 1 GB

impl PartialEq for Limits

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

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

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 StructuralPartialEq for Limits