Struct Mechanism

#[non_exhaustive]
pub struct Mechanism {
    pub mechanism: &'static Mechname,
    /* private fields */
}

Mechanism Implementation

NOTE: The API of custom mechanisms is not stable. You MUST NOT rely on API stability over minor version releases of rsasl.

All mechanisms need to export a static Mechanism to be usable by rsasl, see the registry module documentation for details.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mechanism: &'static Mechname

The Mechanism served by this implementation.

Implementations

impl Mechanism

pub const fn build( mechanism: &'static Mechname, priority: usize, client: Option<StartFn>, server: Option<ServerStartFn>, first: Side, select: fn(bool) -> Option<Selection>, offer: fn(bool) -> bool, ) -> Self

Construct a Mechanism constant for custom mechanisms

NOTE: The API of custom mechanisms is not stable. You MUST NOT rely on API stability over minor version releases of rsasl.

impl Mechanism

pub fn client(&self) -> Option<Result<Box<dyn Authentication>, SASLError>>

pub fn server( &self, sasl: &SASLConfig, ) -> Option<Result<Box<dyn Authentication>, SASLError>>

Trait Implementations

impl Clone for Mechanism

fn clone(&self) -> Mechanism

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mechanism

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

Formats the value using the given formatter.

impl Display for Mechanism

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

Formats the value using the given formatter.

impl Copy for Mechanism