Enum AuthFlavor 

#[non_exhaustive]
pub enum AuthFlavor<T>
where
    T: AsRef<[u8]>,
{
    AuthNone(Option<T>),
    AuthUnix(AuthUnixParams<T>),
    AuthShort(T),
    Unknown {
        id: u32,
        data: T,
    },
}

A set of basic auth flavor types described in RFC 5531.

The deprecated AUTH_DH is not supported, nor is GSS.

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.

AuthNone(Option<T>)

AUTH_NONE with the opaque data the spec allows to be included (typically None).

The provided opaque auth payload must not exceed 200 bytes in length.

AuthUnix(AuthUnixParams<T>)

AUTH_UNIX and the fields it contains.

AuthShort(T)

AUTH_SHORT and its opaque identifier

The provided opaque auth payload must not exceed 200 bytes in length.

Unknown

An authentication credential unknown to this library, but possibly valid and acceptable by the server.

Fields

id: u32

The discriminator for this undefined auth type.

data: T

The opaque data contained within the this flavour.

This payload must not exceed 200 bytes in length.

Implementations

impl<T> AuthFlavor<T>

where T: AsRef<[u8]>,

pub fn serialise_into<W: Write>(&self, buf: W) -> Result<(), Error>

Serialises this auth flavor and writes it into buf.

Panics

Panics if an associated byte payload is provided that exceeds 200 bytes.

pub fn id(&self) -> u32

Returns the ID value used to identify the variant in the wire protocol.

pub fn associated_data_len(&self) -> u32

Returns the byte length of the associated auth data, if any.

pub fn serialised_len(&self) -> u32

Returns the on-wire length of this auth flavor once serialised, including discriminator and length values.

Trait Implementations

impl<T> Clone for AuthFlavor<T>

where T: AsRef<[u8]> + Clone,

fn clone(&self) -> AuthFlavor<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for AuthFlavor<T>

where T: AsRef<[u8]> + Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for AuthFlavor<T>

where T: AsRef<[u8]> + PartialEq,

fn eq(&self, other: &AuthFlavor<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<'a> TryFrom<&'a [u8]> for AuthFlavor<&'a [u8]>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bytes> for AuthFlavor<Bytes>

Available on crate feature bytes only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> StructuralPartialEq for AuthFlavor<T>

where T: AsRef<[u8]>,