Struct ModifyOptionsBuilder

pub struct ModifyOptionsBuilder(/* private fields */);

Utility used to create a ModifyOptions instance.

The following example creates a ModifyOptions instance, which changes the password of the container:

let options = nuts_container::ModifyOptionsBuilder::default()
    .change_password(|| Ok(b"123".to_vec()));

Implementations

impl ModifyOptionsBuilder

pub fn change_kdf(self, kdf: Kdf) -> Self

Changes the key derivation function of the container.

Notes

• If encryption is deactivated, the key derivation function is permanently set to Kdf::None. It cannot be changed.
• If encryption is activated, the key derivation function cannot be set to Kdf::None.

For both exceptions the kdf passed to the method is ignored.

pub fn change_password<Cb: Fn() -> Result<Vec<u8>, String> + 'static>( self, callback: Cb, ) -> Self

Change the password of the container.

Use the given callback which returns the new password on success. If encryption is disabled the callback is not invoked.

On success the callback returns the password (represented as an Vec<u8>) wrapped into an Ok. On any failure an Err with an error message must be returned.

pub fn build(self) -> ModifyOptions

Finally, creates the ModifyOptions instance.

Trait Implementations

impl Default for ModifyOptionsBuilder

fn default() -> Self

Returns the “default value” for a type.