Struct Config 

pub struct Config { /* private fields */ }

Configuring the cryptid library.

Implementations

impl Config

pub fn new(key: &[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)

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

pub fn set_thread_local(config: Config)

Sets the thread-local configuration. This takes precedence over the global configuration for the current thread only.

pub fn clear_thread_local()

Clears the thread-local configuration for the current thread.

pub fn effective() -> Option<Config>

Accesses the effective configuration, checking thread-local first, then global. Thread-local configuration takes precedence over global configuration.

pub fn global() -> Option<Config>

Accesses the global configuration, if set.

Note: Consider using Config::effective() instead, which checks thread-local configuration first.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.