Struct password_hash::SaltString

pub struct SaltString { /* private fields */ }

Owned stack-allocated equivalent of Salt.

Implementations

impl SaltString

pub fn generate(rng: impl CryptoRngCore) -> Self

Available on crate feature rand_core only.

Generate a random B64-encoded SaltString.

pub fn from_b64(s: &str) -> Result<Self>

Create a new SaltString from the given B64-encoded input string, validating Salt::MIN_LENGTH and Salt::MAX_LENGTH restrictions.

pub fn decode_b64<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8]>

Decode this SaltString from B64 into the provided output buffer.

pub fn encode_b64(input: &[u8]) -> Result<Self>

Encode the given byte slice as B64 into a new SaltString.

Returns Error if the slice is too long.

pub fn as_salt(&self) -> Salt<'_>

Borrow the contents of a SaltString as a Salt.

pub fn as_str(&self) -> &str

Borrow the contents of a SaltString as a str.

pub fn len(&self) -> usize

Get the length of this value in ASCII characters.

pub fn new(s: &str) -> Result<Self>

👎Deprecated since 0.5.0: use from_b64 instead

Create a new SaltString from the given B64-encoded input string, validating Salt::MIN_LENGTH and Salt::MAX_LENGTH restrictions.

pub fn b64_decode<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8]>

👎Deprecated since 0.5.0: use decode_b64 instead

Decode this SaltString from B64 into the provided output buffer.

pub fn b64_encode(input: &[u8]) -> Result<Self>

👎Deprecated since 0.5.0: use encode_b64 instead

Encode the given byte slice as B64 into a new SaltString.

Returns Error if the slice is too long.

Trait Implementations

impl AsRef<str> for SaltString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SaltString

fn clone(&self) -> SaltString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SaltString

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

Formats the value using the given formatter.

impl Display for SaltString

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

Formats the value using the given formatter.

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

fn from(salt_string: &'a SaltString) -> Salt<'a>

Converts to this type from the input type.

impl PartialEq for SaltString

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SaltString