Skip to main content

ProcessingLimits

Struct ProcessingLimits 

Source
pub struct ProcessingLimits {
    pub max_file_bytes: u64,
    pub max_stream_bytes: u64,
    pub max_total_memory_bytes: u64,
    pub max_object_depth: u32,
    pub max_operator_count: u64,
    pub max_image_pixels: u64,
    pub max_xfa_nesting_depth: u32,
    pub max_formcalc_depth: u32,
}
Expand description

Resource limits for a single PDF processing operation.

Construct via ProcessingLimits::default() for standard limits, or use the builder methods to customize for your use case.

§Examples

use pdf_engine::limits::ProcessingLimits;

// Default limits (recommended for server-side processing):
let limits = ProcessingLimits::default();

// Stricter limits for WASM/browser context:
let wasm_limits = ProcessingLimits::wasm();

// Custom limits:
let custom = ProcessingLimits::default()
    .max_file_bytes(100 * 1024 * 1024)   // 100 MB
    .max_stream_bytes(64 * 1024 * 1024);  // 64 MB per stream

Fields§

§max_file_bytes: u64

Maximum PDF file size in bytes. Default: 500 MB.

§max_stream_bytes: u64

Maximum decompressed size of any single stream. Default: 256 MB. Prevents zip bombs via FlateDecode or LZWDecode.

§max_total_memory_bytes: u64

Maximum total memory allocated per document. Default: 1 GB.

§max_object_depth: u32

Maximum object reference depth (prevents stack overflow on recursive refs). Default: 100.

§max_operator_count: u64

Maximum content stream operators per page. Default: 10,000,000.

§max_image_pixels: u64

Maximum pixel count per image (width × height). Default: 268,435,456 (16384²).

§max_xfa_nesting_depth: u32

Maximum XFA template XML nesting depth. Default: 50.

§max_formcalc_depth: u32

Maximum FormCalc recursion depth. Default: 200.

Implementations§

Source§

impl ProcessingLimits

Source

pub fn new() -> Self

Create a new set of limits with default values.

Source

pub fn wasm() -> Self

Strict limits for WASM/browser contexts with limited memory.

  • Max file: 50 MB
  • Max stream: 32 MB
  • Max total memory: 128 MB
  • Image pixels: 64 MP (8192×8192)
Source

pub fn unlimited() -> Self

Unlimited: no resource limits (use only in trusted environments).

Source

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

Set maximum PDF file size.

Source

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

Set maximum decompressed stream size.

Source

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

Set maximum total memory per document.

Source

pub fn max_object_depth(self, depth: u32) -> Self

Set maximum object reference depth.

Source

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

Set maximum content stream operator count.

Source

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

Set maximum image pixel count (width × height).

Source

pub fn max_xfa_nesting_depth(self, depth: u32) -> Self

Set maximum XFA template nesting depth.

Source

pub fn max_formcalc_depth(self, depth: u32) -> Self

Set maximum FormCalc recursion depth.

Source

pub fn check_file_size(&self, bytes: u64) -> Result<(), LimitError>

Check if a file size is within limits. Returns Err with a descriptive message if exceeded.

Source

pub fn check_stream_size(&self, bytes: u64) -> Result<(), LimitError>

Check if a decompressed stream size is within limits.

Source

pub fn check_image_pixels( &self, width: u64, height: u64, ) -> Result<(), LimitError>

Check if image dimensions are within limits.

Source

pub fn check_object_depth(&self, depth: u32) -> Result<(), LimitError>

Check if an object depth is within limits.

Trait Implementations§

Source§

impl Clone for ProcessingLimits

Source§

fn clone(&self) -> ProcessingLimits

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 ProcessingLimits

Source§

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

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

impl Default for ProcessingLimits

Source§

fn default() -> Self

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

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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> ErasedDestructor for T
where T: 'static,