Struct Params

pub struct Params { /* private fields */ }

The Argon2 parameters used for the encrypted data.

Implementations

impl Params

pub fn new(ciphertext: impl AsRef<[u8]>) -> Result<Self>

Creates a new instance of the Argon2 parameters from ciphertext.

Errors

Returns Err if any of the following are true:

• ciphertext is shorter than 164 bytes.
• The magic number is invalid.
• The version number is the unsupported abcrypt version number.
• The version number is the unrecognized abcrypt version number.
• The Argon2 type is invalid.
• The Argon2 version is invalid.
• The Argon2 parameters are invalid.

Examples

let ciphertext = include_bytes!("../tests/data/v1/argon2id/v0x13/data.txt.abcrypt");

assert!(Params::new(ciphertext).is_ok());

pub const fn memory_cost(&self) -> u32

Gets memory size in KiB.

Examples

let ciphertext = include_bytes!("../tests/data/v1/argon2id/v0x13/data.txt.abcrypt");

let params = Params::new(ciphertext).unwrap();
assert_eq!(params.memory_cost(), 32);

pub const fn time_cost(&self) -> u32

Gets number of iterations.

Examples

let ciphertext = include_bytes!("../tests/data/v1/argon2id/v0x13/data.txt.abcrypt");

let params = Params::new(ciphertext).unwrap();
assert_eq!(params.time_cost(), 3);

pub const fn parallelism(&self) -> u32

Gets degree of parallelism.

Examples

let ciphertext = include_bytes!("../tests/data/v1/argon2id/v0x13/data.txt.abcrypt");

let params = Params::new(ciphertext).unwrap();
assert_eq!(params.parallelism(), 4);

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl From<Params> for Params

fn from(params: Params) -> Self

Converts to this type from the input type.

impl From<Params> for Params

fn from(params: Params) -> Self

Converts to this type from the input type.

impl Serialize for Params

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Params