Struct WriteOptionsBuilder

pub struct WriteOptionsBuilder { /* private fields */ }

Builder for WriteOptions.

Implementations

impl WriteOptionsBuilder

pub fn compression(&mut self, compression: Compression) -> &mut Self

Set Compression to this builder.

pub fn compression_level( &mut self, compression_level: CompressionLevel, ) -> &mut Self

Set CompressionLevel to this builder.

pub fn encryption(&mut self, encryption: Encryption) -> &mut Self

Set Encryption to this builder.

pub fn cipher_mode(&mut self, cipher_mode: CipherMode) -> &mut Self

Set CipherMode to this builder.

pub fn hash_algorithm(&mut self, algorithm: HashAlgorithm) -> &mut Self

Set HashAlgorithm to this builder.

pub fn password<S: AsRef<str>>(&mut self, password: Option<S>) -> &mut Self

Set the password to this builder.

pub fn build(&self) -> WriteOptions

Create new WriteOptions parameters set from this builder.

Panics

Panic will occur when encryption is enabled and password is not provided.

Trait Implementations

impl Clone for WriteOptionsBuilder

fn clone(&self) -> WriteOptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOptionsBuilder

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

Formats the value using the given formatter.

impl Default for WriteOptionsBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<WriteOptions> for WriteOptionsBuilder

fn from(value: WriteOptions) -> Self

Converts to this type from the input type.

impl Hash for WriteOptionsBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WriteOptionsBuilder

fn cmp(&self, other: &WriteOptionsBuilder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WriteOptionsBuilder

fn eq(&self, other: &WriteOptionsBuilder) -> 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 PartialOrd for WriteOptionsBuilder

fn partial_cmp(&self, other: &WriteOptionsBuilder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for WriteOptionsBuilder

impl StructuralPartialEq for WriteOptionsBuilder