Enum Algorithm 

#[non_exhaustive]
pub enum Algorithm {
    SHA1,
    SHA256,
    SHA512,
    Steam,
}

Algorithm enum holds the three standards algorithms for TOTP as per the reference implementation

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SHA1

HMAC-SHA1 is the default algorithm of most TOTP implementations. Some will outright silently ignore the algorithm parameter to force using SHA1, leading to confusion.

SHA256

HMAC-SHA256. Supported in theory according to yubico. Ignored in practice by most.

SHA512

HMAC-SHA512. Supported in theory according to yubico. Ignored in practice by most.

Steam

Available on crate feature steam only.

Steam TOTP token algorithm.

Implementations

impl Algorithm

pub const fn as_str(&self) -> &str

Returns a name for this algorithm.

Trait Implementations

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Algorithm

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Default for Algorithm

fn default() -> Algorithm

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Algorithm

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl Eq for Algorithm

impl From<Algorithm> for String

Available on crate feature alloc only.

fn from(value: Algorithm) -> Self

Converts to this type from the input type.

impl FromStr for Algorithm

type Err = UnsupportedAlgorithm

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Algorithm

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Algorithm

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Algorithm

impl TryFrom<String> for Algorithm

Available on crate feature alloc only.

type Error = UnsupportedAlgorithm

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.