Struct Totp

pub struct Totp<'t> {
    pub base: Base<'t>,
    pub skew: Skew,
    pub period: Period,
}

Represents TOTP configurations.

Fields

base: Base<'t>

The base configuration.

skew: Skew

The skew to apply.

period: Period

The period to use.

Implementations

impl<'t> Totp<'t>

pub fn builder() -> TotpBuilder<'t>

Create an instance of Totp using the builder syntax

impl<'t> Totp<'t>

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

Returns the base configuration.

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

Returns the mutable base configuration.

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

Consumes Self, returning the base configuration.

impl Totp<'_>

pub const fn input_at(&self, time: u64) -> u64

Returns the input value corresponding to the given time.

pub const fn next_period_at(&self, time: u64) -> u64

Returns the time corresponding to the next period from the given time.

pub fn try_next_period(&self) -> Result<u64, Error>

Tries to return the time corresponding to the next period from the current time.

Errors

Returns time::Error if the system time is before the epoch.

pub fn next_period(&self) -> u64

Returns the time corresponding to the next period from the current time.

Panics

Panics if the system time is before the epoch.

pub const fn time_to_live_at(&self, time: u64) -> u64

Returns the time to live of the code for the given time.

pub fn try_time_to_live(&self) -> Result<u64, Error>

Tries to return the time to live of the code for the current time.

Errors

Returns time::Error if the system time is before the epoch.

pub fn time_to_live(&self) -> u64

Returns the time to live of the code for the current time.

Panics

Panics if the system time is before the epoch.

pub fn generate_at(&self, time: u64) -> u32

Generates the code for the given time.

pub fn generate_string_at(&self, time: u64) -> String

Generates the string code for the given time.

pub fn try_generate(&self) -> Result<u32, Error>

Tries to generate the code for the current time.

Errors

Returns time::Error if the system time is before the epoch.

pub fn generate(&self) -> u32

Generates the code for the current time.

Panics

Panics if the system time is before the epoch.

pub fn try_generate_string(&self) -> Result<String, Error>

Tries to generate the string code for the current time.

Errors

Returns time::Error if the system time is before the epoch.

pub fn generate_string(&self) -> String

Generates the string code for the current time.

Panics

Panics if the system time is before the epoch.

pub fn verify_exact_at(&self, time: u64, code: u32) -> bool

Verifies the given code for the given time.

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

Verifies the given string code for the given time.

pub fn try_verify_exact(&self, code: u32) -> Result<bool, Error>

Tries to verify the given code for the current time exactly.

Errors

Returns time::Error if the system time is before the epoch.

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

Verifies the given code for the current time exactly.

Panics

Panics if the system time is before the epoch.

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

Tries to verify the given string code for the current time exactly.

Errors

Returns time::Error if the system time is before the epoch.

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

Verifies the given string code for the current time exactly.

Panics

Panics if the system time is before the epoch.

pub fn verify_at(&self, time: u64, code: u32) -> bool

Verifies the given code for the given time, accounting for skews.

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

Verifies the given string code for the given time, accounting for skews.

pub fn try_verify(&self, code: u32) -> Result<bool, Error>

Tries to verify the given code for the current time, accounting for skews.

Errors

Returns time::Error if the system time is before the epoch.

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

Verifies the given code for the current time, accounting for skews.

Panics

Panics if the system time is before the epoch.

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

Tries to verify the given string code for the current time, accounting for skews.

Errors

Returns time::Error if the system time is before the epoch.

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

Verifies the given string code for the current time, accounting for skews.

Panics

Panics if the system time is before the epoch.

impl Totp<'_>

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

Available on crate feature auth only.

Applies the HOTP configuration to the given URL.

Note that this method applies the base configuration on its own.

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

Available on crate feature auth only.

Extracts the TOTP configuration from the given query.

Errors

Returns Error if extraction fails.

impl Totp<'_>

pub fn into_owned(self) -> Owned

Converts Self into Owned.

Trait Implementations

impl<'t> Clone for Totp<'t>

fn clone(&self) -> Totp<'t>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for Totp<'t>

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

Formats the value using the given formatter.

impl<'de, 't> Deserialize<'de> for Totp<'t>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'t> From<Totp<'t>> for Otp<'t>

fn from(totp: Totp<'t>) -> Self

Converts to this type from the input type.

impl<'t> Hash for Totp<'t>

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<'t> PartialEq for Totp<'t>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'t> Eq for Totp<'t>

impl<'t> StructuralPartialEq for Totp<'t>