Struct ruma_common::events::secret_storage::key::PassPhrase

#[non_exhaustive]
pub struct PassPhrase {
    pub algorithm: KeyDerivationAlgorithm,
    pub salt: String,
    pub iterations: UInt,
    pub bits: UInt,
}

A passphrase from which a key is to be derived.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

algorithm: KeyDerivationAlgorithm

The algorithm to use to generate the key from the passphrase.

Must be m.pbkdf2.

salt: String

The salt used in PBKDF2.

iterations: UInt

The number of iterations to use in PBKDF2.

bits: UInt

The number of bits to generate for the key.

Defaults to 256

Implementations

impl PassPhrase

pub fn new(salt: String, iterations: UInt) -> Self

Creates a new PassPhrase with a given salt and number of iterations.

Trait Implementations

impl Clone for PassPhrase

fn clone(&self) -> PassPhrase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PassPhrase

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PassPhrase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for PassPhrase

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

Serialize this value into the given Serde serializer.