Struct bonsaidb::local::argon2::ParamsBuilder

pub struct ParamsBuilder { /* private fields */ }

Builder for Argon2 Params.

Implementations

impl ParamsBuilder

pub const fn new() -> ParamsBuilder

Create a new builder with the default parameters.

pub fn m_cost(&mut self, m_cost: u32) -> &mut ParamsBuilder

Set memory size, expressed in kibibytes, between 1 and (2^32)-1.

pub fn t_cost(&mut self, t_cost: u32) -> &mut ParamsBuilder

Set number of iterations, between 1 and (2^32)-1.

pub fn p_cost(&mut self, p_cost: u32) -> &mut ParamsBuilder

Set degree of parallelism, between 1 and 255.

pub fn keyid(&mut self, keyid: KeyId) -> &mut ParamsBuilder

Set key identifier.

pub fn data(&mut self, data: AssociatedData) -> &mut ParamsBuilder

Set associated data.

pub fn output_len(&mut self, len: usize) -> &mut ParamsBuilder

Set length of the output (in bytes).

pub const fn build(&self) -> Result<Params, Error>

Get the finished Params.

This performs validations to ensure that the given parameters are valid and compatible with each other, and will return an error if they are not.

pub fn context( &self, algorithm: Algorithm, version: Version ) -> Result<Argon2<'_>, Error>

Create a new Argon2 context using the provided algorithm/version.

pub const DEFAULT: ParamsBuilder = { let params = Params::DEFAULT; Self{ m_cost: params.m_cost, t_cost: params.t_cost, p_cost: params.p_cost, keyid: None, data: None, output_len: params.output_len,} }

Default parameters (recommended).

Trait Implementations

impl Clone for ParamsBuilder

fn clone(&self) -> ParamsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParamsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ParamsBuilder

fn default() -> ParamsBuilder

Returns the “default value” for a type.

impl PartialEq<ParamsBuilder> for ParamsBuilder

fn eq(&self, other: &ParamsBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<ParamsBuilder> for Params

type Error = Error

The type returned in the event of a conversion error.

fn try_from(builder: ParamsBuilder) -> Result<Params, Error>

Performs the conversion.

impl Eq for ParamsBuilder

impl StructuralEq for ParamsBuilder

impl StructuralPartialEq for ParamsBuilder