Struct FileOptions

Source

pub struct FileOptions { /* private fields */ }

Expand description

Metadata for a file to be written

Implementations§

Source §

impl FileOptions

Source

pub fn compression_method(self, method: CompressionMethod) -> FileOptions

Set the compression method for the new file

The default is CompressionMethod::Deflated. If the deflate compression feature is disabled, CompressionMethod::Stored becomes the default.

Source

pub fn compression_level(self, level: Option<i32>) -> FileOptions

Set the compression level for the new file

None value specifies default compression level.

Range of values depends on compression method:

Deflated: 0 - 9. Default is 6
Bzip2: 0 - 9. Default is 6
Zstd: -7 - 22, with zero being mapped to default level. Default is 3
others: only None is allowed

Source

pub fn last_modified_time(self, mod_time: DateTime) -> FileOptions

Set the last modified time

The default is the current timestamp if the ‘time’ feature is enabled, and 1980-01-01 otherwise

Source

pub fn unix_permissions(self, mode: u32) -> FileOptions

Set the permissions for the new file.

The format is represented with unix-style permissions. The default is 0o644, which represents rw-r--r-- for files, and 0o755, which represents rwxr-xr-x for directories.

This method only preserves the file permissions bits (via a & 0o777) and discards higher file mode bits. So it cannot be used to denote an entry as a directory, symlink, or other special file type.

Source

pub fn large_file(self, large: bool) -> FileOptions

Set whether the new file’s compressed and uncompressed size is less than 4 GiB.

If set to false and the file exceeds the limit, an I/O error is thrown. If set to true, readers will require ZIP64 support and if the file does not exceed the limit, 20 B are wasted. The default is false.

Trait Implementations§

Source §

impl Clone for FileOptions

Source §

fn clone(&self) -> FileOptions

Returns a copy 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 Default for FileOptions

Source §

fn default() -> Self

Construct a new FileOptions object

Source §

impl FileOptionsExt for FileOptions

Source §

fn with_deprecated_encryption(self, password: &[u8]) -> Self

Write the file with the given password using the deprecated ZipCrypto algorithm. Read more

Source §

impl Copy for FileOptions

Auto Trait Implementations§

§

impl UnwindSafe for FileOptions

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 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 §