Struct Memory 

pub struct Memory(/* private fields */);

A memory cost, carried in kibibytes.

The unit is the point of this type. Argon2’s m_cost is a count of 1 KiB blocks, so a bare 65536 at a call site could be read as bytes, KiB, MiB or blocks; Memory::mib(64) cannot.

No constructor validates or panics. The value is held as a u64 and checked once, by ParamsBuilder::build, which is the only place that knows the target’s MAX_MEMORY.

use argon2_rust::params::Memory;

assert_eq!(Memory::mib(64), Memory::kib(65536));
assert_eq!(Memory::gib(1), Memory::mib(1024));

Implementations

impl Memory

pub const fn kib(kib: u64) -> Memory

A cost in kibibytes, the unit Argon2’s m_cost uses.

pub const fn mib(mib: u64) -> Memory

A cost in mebibytes.

Saturating, not wrapping: mib(u64::MAX) yields u64::MAX KiB rather than panicking in a debug build. Any saturated value is far above MAX_MEMORY and becomes Error::MemoryTooMuch at build().

pub const fn gib(gib: u64) -> Memory

A cost in gibibytes. Saturating, for the reason given on Memory::mib.

pub const fn as_kib(self) -> u64

The cost in kibibytes.

Trait Implementations

impl Clone for Memory

fn clone(&self) -> Memory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Memory

impl Debug for Memory

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

Formats the value using the given formatter.

impl Eq for Memory

impl Hash for Memory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Memory

fn cmp(&self, other: &Memory) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Memory

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Memory

fn partial_cmp(&self, other: &Memory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Memory