Skip to main content

OpenOptions

Struct OpenOptions 

Source
pub struct OpenOptions {
    pub parsing_mode: ParsingMode,
    pub password: Option<String>,
    pub max_decompressed_stream_size: u64,
    pub max_compression_ratio: u32,
    pub max_operators_per_page: u64,
    pub max_endstream_scan_distance: u64,
}
Expand description

Options for opening a PDF document.

All fields have sensible defaults via the Default implementation. Soft limits can be adjusted for trusted inputs that exceed the defaults.

Fields§

§parsing_mode: ParsingMode

Parsing mode (default: ParsingMode::Lenient).

§password: Option<String>

Password for encrypted documents (default: None).

§max_decompressed_stream_size: u64

Maximum decompressed stream size in bytes (default: 256 MB).

Prevents decompression bombs.

§max_compression_ratio: u32

Maximum compression ratio before aborting (default: 1000:1).

A ratio exceeding this strongly indicates a zip bomb.

§max_operators_per_page: u64

Maximum content stream operators per page (default: 10,000,000).

§max_endstream_scan_distance: u64

Maximum distance to scan for endstream keyword (default: 16 MB).

Implementations§

Source§

impl OpenOptions

Source

pub fn with_parsing_mode(self, mode: ParsingMode) -> Self

Set the parsing mode.

Source

pub fn with_password(self, password: impl Into<String>) -> Self

Set the password for encrypted documents.

Source

pub fn with_max_decompressed_stream_size(self, size: u64) -> Self

Set the maximum decompressed stream size in bytes.

Source

pub fn with_max_compression_ratio(self, ratio: u32) -> Self

Set the maximum compression ratio before aborting.

Source

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

Set the maximum content stream operators per page.

Source

pub fn with_max_endstream_scan_distance(self, distance: u64) -> Self

Set the maximum distance to scan for endstream.

Trait Implementations§

Source§

impl Clone for OpenOptions

Source§

fn clone(&self) -> OpenOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenOptions

Source§

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

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

impl Default for OpenOptions

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