Struct argon2::ParamsBuilder

pub struct ParamsBuilder { /* private fields */ }

Builder for Argon2 Params.

Implementations

impl ParamsBuilder

pub fn new() -> Self

Create a new builder with the default parameters.

pub fn m_cost(&mut self, m_cost: u32) -> Result<&mut Self>

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

pub fn t_cost(&mut self, t_cost: u32) -> Result<&mut Self>

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

pub fn p_cost(&mut self, p_cost: u32) -> Result<&mut Self>

Set degree of parallelism, between 1 and 255.

pub fn keyid(&mut self, keyid: &[u8]) -> Result<&mut Self>

Set key identifier.

Must be 8-bytes or less.

pub fn data(&mut self, bytes: &[u8]) -> Result<&mut Self>

Set associated data.

Must be 32-bytes or less.

pub fn output_len(&mut self, len: usize) -> Result<&mut Self>

Set length of the output (in bytes).

pub fn params(self) -> Result<Params>

Get the finished Params.

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

The main validation is that m_cost < p_cost * 8

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

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: &ParamsBuilder) -> bool

This method tests for !=.

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>

Performs the conversion.

impl Eq for ParamsBuilder

impl StructuralEq for ParamsBuilder

impl StructuralPartialEq for ParamsBuilder