Struct Hotp

pub struct Hotp<'h> {
    pub base: Base<'h>,
    pub counter: Counter,
}

Represents HOTP configuration.

Fields

base: Base<'h>

The base configuration.

counter: Counter

The counter used to generate codes.

Implementations

impl<'h> Hotp<'h>

pub fn builder() -> HotpBuilder<'h>

Create an instance of Hotp using the builder syntax

impl<'h> Hotp<'h>

pub const fn base(&self) -> &Base<'h>

Returns the base configuration.

pub fn base_mut(&mut self) -> &mut Base<'h>

Returns the mutable base configuration.

pub fn into_base(self) -> Base<'h>

Consumes Self, returning the base configuration.

impl Hotp<'_>

pub const fn counter(&self) -> u64

Returns the current counter value.

pub fn try_increment(&mut self) -> bool

Tries to increment the counter, returning bool indicating success.

pub fn increment(&mut self)

Increments the counter, panicking on overflows.

Panics

This method will panic if the counter overflows.

pub fn generate(&self) -> u32

Generates the code for the current counter value.

pub fn generate_string(&self) -> String

Generates the string code for the current counter value.

pub fn verify(&self, code: u32) -> bool

Verifies the code for the current counter value.

pub fn verify_string<S: AsRef<str>>(&self, code: S) -> bool

Verifies the string code for the current counter value.

impl Hotp<'_>

pub fn query_for(&self, url: &mut Url)

Available on crate feature auth only.

Applies the HOTP configuration to the given URL.

pub fn extract_from(query: &mut Query<'_>) -> Result<Self, Error>

Available on crate feature auth only.

Extracts the HOTP configuration from the given query.

Errors

Returns Error if the HOTP configuration could not be extracted.

impl Hotp<'_>

pub fn into_owned(self) -> Owned

Converts Self into Owned.

Trait Implementations

impl<'h> Clone for Hotp<'h>

fn clone(&self) -> Hotp<'h>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'h> Debug for Hotp<'h>

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

Formats the value using the given formatter.

impl<'de, 'h> Deserialize<'de> for Hotp<'h>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'h> From<Hotp<'h>> for Otp<'h>

fn from(hotp: Hotp<'h>) -> Self

Converts to this type from the input type.

impl<'h> Hash for Hotp<'h>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'h> PartialEq for Hotp<'h>

fn eq(&self, other: &Hotp<'h>) -> 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<'h> Serialize for Hotp<'h>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'h> Eq for Hotp<'h>

impl<'h> StructuralPartialEq for Hotp<'h>