Struct Auth

pub struct Auth<'a> {
    pub otp: Otp<'a>,
    pub label: Label<'a>,
}

Available on crate feature auth only.

Represents OTP authentication.

Fields

otp: Otp<'a>

The OTP configuration.

label: Label<'a>

The authentication label.

Implementations

impl<'a> Auth<'a>

pub fn builder() -> AuthBuilder<'a>

Create an instance of Auth using the builder syntax

impl Auth<'_>

pub const fn otp(&self) -> &Otp<'_>

Returns the OTP configuration reference.

pub const fn label(&self) -> &Label<'_>

Returns the label reference.

impl<'a> Auth<'a>

pub fn from_parts(parts: Parts<'a>) -> Self

Constructs Self from parts.

pub fn into_parts(self) -> Parts<'a>

Consumes Self, returning the contained parts.

impl Auth<'_>

pub fn base_url(&self) -> Url

Constructs the OTP URL base.

Panics

The base URL is always valid, so this method should never panic.

pub fn build_url(&self) -> Url

Builds the OTP URL, applying query parameters to the base URL created.

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

Applies the OTP configuration and the issuer to the given URL.

pub fn parse_url<S: AsRef<str>>(string: S) -> Result<Self, Error>

Parses the OTP URL from the given string.

Errors

Returns Error if anything goes wrong.

impl Auth<'_>

pub fn into_owned(self) -> Owned

Converts Self into Owned.

Trait Implementations

impl<'a> Clone for Auth<'a>

fn clone(&self) -> Auth<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Auth<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Auth<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'p> From<(Otp<'p>, Label<'p>)> for Auth<'p>

fn from(parts: Parts<'p>) -> Self

Converts to this type from the input type.

impl<'a> From<Auth<'a>> for Parts<'a>

fn from(auth: Auth<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Auth<'a>

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<'a> PartialEq for Auth<'a>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Auth<'a>

impl<'a> StructuralPartialEq for Auth<'a>