pub struct ParamsBuilder { /* private fields */ }
Expand description

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 8*p_cost 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 (2^24)-1.

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 = _

Default parameters (recommended).

Trait Implementations§

§

impl Clone for ParamsBuilder

§

fn clone(&self) -> ParamsBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ParamsBuilder

§

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

Formats the value using the given formatter. Read more
§

impl Default for ParamsBuilder

§

fn default() -> ParamsBuilder

Returns the “default value” for a type. Read more
§

impl PartialEq for ParamsBuilder

§

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

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

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more