Struct argonautica::input::Salt

pub struct Salt(_);

Type-safe struct representing the raw bytes of your salt

Note: A Salt knows if it's random or deterministic:

• A Salt will be random if it's constructed via the default or random constructors. It will be deterministic if it's constructed via any of the various From implementations
• A random Salt will generate new random bytes using a cryptographically-secure random number generator (EntropyRng) upon each call to hash, hash_raw or their non-blocking equivalents. A deterministic Salt remain constant upon each of these calls

Methods

impl Salt

pub fn random(len: u32) -> Salt

Creates a new random Salt.

Initially, the random Salt has nothing in it, but every time you call hash, hash_raw, or their non-blocking equivalents on a Hasher, the Salt will update with new random bytes of the length specified generated using a cryptographically-secure random number generator (EntropyRng)

pub fn as_bytes(&self) -> &[u8]

Read-only access to the underlying byte buffer

pub fn is_random(&self) -> bool

Returns true if the Salt is random; false if it is deterministic

pub fn len(&self) -> usize

Read-only acccess to the underlying byte buffer's length

pub fn to_str(&self) -> Result<&str, Error>

Read-only access to the underlying byte buffer as a &str if its bytes are valid utf-8

pub fn update(&mut self) -> Result<(), Error>

If you have a random Salt, this method will generate new random bytes of the length of your Salt. If you have a deterministic Salt, this method does nothing

Trait Implementations

impl Default for Salt

fn default() -> Salt

Creates a new random Salt.

Initially, the random Salt has nothing in it, but every time you call hash, hash_raw, or their non-blocking equivalents on a Hasher, the Salt will update with 32 new random bytes generated using a cryptographically-secure random number generator (EntropyRng)

impl From<Vec<u8>> for Salt

fn from(bytes: Vec<u8>) -> Salt

Performs the conversion.

impl From<String> for Salt

fn from(s: String) -> Salt

Performs the conversion.

impl<'a> From<&'a [u8]> for Salt

fn from(bytes: &[u8]) -> Salt

Performs the conversion.

impl<'a> From<&'a str> for Salt

fn from(s: &str) -> Salt

Performs the conversion.

impl<'a> From<&'a Vec<u8>> for Salt

fn from(bytes: &Vec<u8>) -> Salt

Performs the conversion.

impl<'a> From<&'a String> for Salt

fn from(s: &String) -> Salt

Performs the conversion.

impl<'a> From<&'a Salt> for Salt

fn from(salt: &Salt) -> Salt

Performs the conversion.

impl Clone for Salt

fn clone(&self) -> Salt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Salt

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

Formats the value using the given formatter.

impl Eq for Salt

impl PartialEq for Salt

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

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

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

This method tests for !=.

impl Ord for Salt

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialOrd for Salt

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Hash for Salt

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,

Feeds a slice of this type into the given [Hasher].