Struct OpenOptionsBuilder

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

Utility used to create a OpenOptions instance.

Implementations

impl OpenOptionsBuilder

pub fn new() -> Self

Creates a builder instance.

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

Assigns a password callback to the container.

A password is needed, when encryption is enabled for the container. Based on the password a wrapping key is generated, which encrypts the secret part of the header. If encryption is enabled but no password callback is assigned, an Error::NoPassword error is raised. If encryption is disabled, no password is needed and an assigned callback is never called.

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<B: Backend>(self) -> ContainerResult<OpenOptions, B>

Creates the OpenOptions instance.

Before the OpenOptions instance is created all options passed to the builder are validated.

Errors

If validation has failed an Error is returned.

Trait Implementations

impl Default for OpenOptionsBuilder

fn default() -> Self

Returns the “default value” for a type.