Skip to main content

OpenOptions

Struct OpenOptions 

Source
pub struct OpenOptions {
    pub sheet_rows: Option<u32>,
    pub sheets: Option<Vec<String>>,
    pub max_unzip_size: Option<u64>,
    pub max_zip_entries: Option<usize>,
}
Expand description

Options for controlling how a workbook is opened and parsed.

All fields default to None (no limit / parse everything). Use the builder-style setter methods for convenience.

Fields§

§sheet_rows: Option<u32>

Maximum number of rows to read per sheet. Rows beyond this limit are silently discarded during parsing.

§sheets: Option<Vec<String>>

Only parse sheets whose names are in this list. Sheets not listed are represented as empty worksheets (their XML is not parsed). None means parse all sheets.

§max_unzip_size: Option<u64>

Maximum total decompressed size of all ZIP entries in bytes. Exceeding this limit returns [Error::ZipSizeExceeded]. Default when None: no limit.

§max_zip_entries: Option<usize>

Maximum number of ZIP entries allowed. Exceeding this limit returns [Error::ZipEntryCountExceeded]. Default when None: no limit.

Implementations§

Source§

impl OpenOptions

Source

pub fn new() -> Self

Create a new OpenOptions with all defaults (no limits, parse everything).

Source

pub fn sheet_rows(self, rows: u32) -> Self

Set the maximum number of rows to read per sheet.

Source

pub fn sheets(self, names: Vec<String>) -> Self

Only parse sheets whose names are in this list.

Source

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

Set the maximum total decompressed size in bytes.

Source

pub fn max_zip_entries(self, count: usize) -> Self

Set the maximum number of ZIP entries.

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() -> OpenOptions

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.