Struct imap_codec::auth::AuthMechanism

pub struct AuthMechanism<'a>(_);

Authentication mechanism.

It’s recommended to use the pre-defined constants, such as, AuthMechanism::PLAIN. Still, you can also (try to) construct an authentication mechanism from a value.

use imap_types::{auth::AuthMechanism, core::Atom};

assert_eq!(AuthMechanism::PLAIN, AuthMechanism::try_from("plain")?);
assert_eq!(
    AuthMechanism::PLAIN,
    AuthMechanism::try_from(b"PLAIN".as_ref())?,
);
assert_eq!(
    AuthMechanism::PLAIN,
    AuthMechanism::from(Atom::try_from("pLAiN")?)
);

let mechanism = AuthMechanism::try_from(b"login".as_ref())?;

match mechanism {
    AuthMechanism::PLAIN => {}
    AuthMechanism::LOGIN => {}
    _ => {}
}

Implementations

impl<'a> AuthMechanism<'a>

pub const PLAIN: AuthMechanism<'static> = AuthMechanism(Inner::Plain)

The PLAIN SASL mechanism.

AUTH=PLAIN

base64(b"<authenticate-id>\x00<authorize-id>\x00<password>")

Reference(s):

• RFC4616: The PLAIN Simple Authentication and Security Layer (SASL) Mechanism

pub const LOGIN: AuthMechanism<'static> = AuthMechanism(Inner::Login)

The (non-standardized and slow) LOGIN SASL mechanism.

AUTH=LOGIN

base64(b"<username>")
base64(b"<password>")

Reference(s):

• draft-murchison-sasl-login-00: The LOGIN SASL Mechanism

pub const XOAUTH2: AuthMechanism<'static> = AuthMechanism(Inner::XOAuth2)

Google’s OAuth 2.0 mechanism.

AUTH=XOAUTH2

base64(b"user=<user>\x01auth=Bearer <token>\x01\x01")

Reference(s):

• https://developers.google.com/gmail/imap/xoauth2-protocol

Trait Implementations

impl<'a> Arbitrary<'a> for AuthMechanism<'a>

fn arbitrary(u: &mut Unstructured<'a>) -> Result<AuthMechanism<'a>, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<'a> Clone for AuthMechanism<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AuthMechanism<'a>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<'a> Display for AuthMechanism<'a>

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

Formats the value using the given formatter.

impl<'a> From<Atom<'a>> for AuthMechanism<'a>

fn from(atom: Atom<'a>) -> AuthMechanism<'a>

Converts to this type from the input type.

impl<'a> Hash for AuthMechanism<'a>

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

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> IntoBoundedStatic for AuthMechanism<'a>

type Static = AuthMechanism<'static>

The target type is bounded by the 'static lifetime.

fn into_static(self) -> <AuthMechanism<'a> as IntoBoundedStatic>::Static

Convert an owned T into an owned T such that T: 'static.

impl<'a> PartialEq<AuthMechanism<'a>> for AuthMechanism<'a>

fn eq(&self, other: &AuthMechanism<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for AuthMechanism<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> ToBoundedStatic for AuthMechanism<'a>

type Static = AuthMechanism<'static>

The target type is bounded by the 'static lifetime.

fn to_static(&self) -> <AuthMechanism<'a> as ToBoundedStatic>::Static

Convert an &T to an owned T such that T: 'static.

impl<'a> TryFrom<&'a [u8]> for AuthMechanism<'a>

type Error = <Atom<'a> as TryFrom<&'a [u8]>>::Error

The type returned in the event of a conversion error.

fn try_from( value: &'a [u8] ) -> Result<AuthMechanism<'a>, <AuthMechanism<'a> as TryFrom<&'a [u8]>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for AuthMechanism<'a>

type Error = <Atom<'a> as TryFrom<&'a str>>::Error

The type returned in the event of a conversion error.

fn try_from( value: &'a str ) -> Result<AuthMechanism<'a>, <AuthMechanism<'a> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<'a> TryFrom<Cow<'a, str>> for AuthMechanism<'a>

type Error = <Atom<'a> as TryFrom<Cow<'a, str>>>::Error

The type returned in the event of a conversion error.

fn try_from( value: Cow<'a, str> ) -> Result<AuthMechanism<'a>, <AuthMechanism<'a> as TryFrom<Cow<'a, str>>>::Error>

Performs the conversion.

impl<'a> TryFrom<String> for AuthMechanism<'a>

type Error = <Atom<'a> as TryFrom<String>>::Error

The type returned in the event of a conversion error.

fn try_from( value: String ) -> Result<AuthMechanism<'a>, <AuthMechanism<'a> as TryFrom<String>>::Error>

Performs the conversion.

impl<'a> TryFrom<Vec<u8, Global>> for AuthMechanism<'a>

type Error = <Atom<'a> as TryFrom<Vec<u8, Global>>>::Error

The type returned in the event of a conversion error.

fn try_from( value: Vec<u8, Global> ) -> Result<AuthMechanism<'a>, <AuthMechanism<'a> as TryFrom<Vec<u8, Global>>>::Error>

Performs the conversion.

impl<'a> Eq for AuthMechanism<'a>

impl<'a> StructuralEq for AuthMechanism<'a>

impl<'a> StructuralPartialEq for AuthMechanism<'a>