Struct WriteOptionsBuilder 

pub struct WriteOptionsBuilder { /* private fields */ }

Builder for WriteOptions.

Implementations

impl WriteOptionsBuilder

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

Sets the Compression.

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

Sets the CompressionLevel.

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

Sets the Encryption.

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

Sets the CipherMode.

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

Sets the HashAlgorithm.

pub fn password<B>(&mut self, password: Option<B>) -> &mut WriteOptionsBuilder

where B: AsRef<[u8]>,

Sets the password.

Accepts both UTF-8 strings and arbitrary byte slices.

Examples

use libpna::WriteOptions;

// String password
WriteOptions::builder().password(Some("my_password"));

// Byte slice password
WriteOptions::builder().password(Some(b"binary_password"));
WriteOptions::builder().password(Some(&[0x01, 0x02, 0x03, 0x04]));

pub fn build(&self) -> WriteOptions

Creates a new WriteOptions from this builder.

This finalizes the builder configuration and creates an immutable WriteOptions that can be used when creating entries.

Panics

Panics if encryption() was set to Encryption::Aes or Encryption::Camellia but password() was not called with a password.

Always provide a password when enabling encryption. The following code will panic:

use libpna::{WriteOptions, Encryption};

let opts = WriteOptions::builder()
    .encryption(Encryption::Aes)
    .build();  // PANICS: "Password was not provided."

Correct usage:

use libpna::{WriteOptions, Encryption};

let opts = WriteOptions::builder()
    .encryption(Encryption::Aes)
    .password(Some("secure_password"))
    .build();  // OK

Trait Implementations

impl Clone for WriteOptionsBuilder

fn clone(&self) -> WriteOptionsBuilder

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for WriteOptionsBuilder

fn default() -> WriteOptionsBuilder

Returns the “default value” for a type.

impl From<WriteOptions> for WriteOptionsBuilder

fn from(value: WriteOptions) -> WriteOptionsBuilder

Converts to this type from the input type.

impl Hash for WriteOptionsBuilder

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

where __H: Hasher,

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