Trait Mechanism

pub trait Mechanism {
    // Required methods
    fn name(&self) -> &str;
    fn from_credentials(
        credentials: Credentials,
    ) -> Result<Self, MechanismError>
       where Self: Sized;

    // Provided methods
    fn initial(&mut self) -> Vec<u8>  { ... }
    fn response(&mut self, _challenge: &[u8]) -> Result<Vec<u8>, MechanismError> { ... }
    fn success(&mut self, _data: &[u8]) -> Result<(), MechanismError> { ... }
}

A trait which defines SASL mechanisms.

Required Methods

fn name(&self) -> &str

The name of the mechanism.

fn from_credentials(credentials: Credentials) -> Result<Self, MechanismError>

where Self: Sized,

Creates this mechanism from Credentials.

Provided Methods

fn initial(&mut self) -> Vec<u8>

Provides initial payload of the SASL mechanism.

fn response(&mut self, _challenge: &[u8]) -> Result<Vec<u8>, MechanismError>

Creates a response to the SASL challenge.

fn success(&mut self, _data: &[u8]) -> Result<(), MechanismError>

Verifies the server success response, if there is one.

Implementors

impl Mechanism for Anonymous

impl Mechanism for Plain

impl<S: ScramProvider> Mechanism for Scram<S>

Available on crate feature scram only.