Struct cryptid_rs::Config

pub struct Config<'a> { /* private fields */ }

Configuring the cryptid library.

Implementations

impl<'a> Config<'a>

pub fn new(key: &'a [u8]) -> Self

Creates a new configuration with the given master key and other settings in default values.

• mac_length defaults to 4, which is large enough to make guessing impractical but still keeps the strings relatively short. High security applications may want to use a higher value.
• zero_pad_length defaults to 4, which is large enough for most applications to never see encoded strings increase in size, while still keeping the strings relatively short.

pub fn hmac_length(self, hmac_length: u8) -> Result<Self, ConfigError>

Sets the number of bytes in the HMAC. The value must be between 0 and 8.

pub fn zero_pad_length(self, zero_pad_length: u8) -> Result<Self, ConfigError>

Sets the number of bytes to zero-pad numbers before encoding. The value must be between 0 and 8.

pub fn set_global(config: Config<'static>)

Sets the global configuration. This should be called before the Field type methods are called.

pub fn global() -> Option<Config<'static>>

Accesses the global configuration, if set.

Trait Implementations

impl<'a> Clone for Config<'a>

fn clone(&self) -> Config<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.