Enum ScramMechanism 

#[non_exhaustive]
pub enum ScramMechanism {
    Unknown,
    ScramSha256,
    ScramSha512,
}

Representation of a SASL/SCRAM Mechanism.

See KIP-554: Add Broker-side SCRAM Config API.

This code is duplicated in crate::common::security::scram::internals::ScramMechanism. The type field in both files must match and must not change. The type field is used both for passing ScramCredentialUpsertion and for the internal UserScramCredentialRecord. Do not change the type field.

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.

Unknown

An unknown / unsupported mechanism (type indicator 0).

ScramSha256

SCRAM-SHA-256 (type indicator 1).

ScramSha512

SCRAM-SHA-512 (type indicator 2).

Implementations

impl ScramMechanism

pub fn from_type(type: i8) -> ScramMechanism

Returns the instance corresponding to the given type indicator, otherwise ScramMechanism::Unknown.

Arguments

• r#type - the type indicator.

pub fn from_mechanism_name(mechanism_name: &str) -> ScramMechanism

Returns the mechanism corresponding to the SASL SCRAM mechanism name, otherwise ScramMechanism::Unknown.

Arguments

• mechanism_name - the SASL SCRAM mechanism name

pub fn mechanism_name(self) -> &'static str

Returns the corresponding SASL SCRAM mechanism name: SCRAM-SHA-256, SCRAM-SHA-512, or UNKNOWN.

See also

• Salted Challenge Response Authentication Mechanism (SCRAM) SASL and GSS-API Mechanisms, Section 4

pub fn type(self) -> i8

Returns the type indicator for this SASL SCRAM mechanism.

Trait Implementations

impl Clone for ScramMechanism

fn clone(&self) -> ScramMechanism

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScramMechanism

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

Formats the value using the given formatter.

impl Display for ScramMechanism

Java’s inherited Enum.toString(): the constant’s name.

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

Formats the value using the given formatter.

impl Hash for ScramMechanism

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 Ord for ScramMechanism

fn cmp(&self, other: &ScramMechanism) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ScramMechanism

fn eq(&self, other: &ScramMechanism) -> 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 PartialOrd for ScramMechanism

fn partial_cmp(&self, other: &ScramMechanism) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ScramMechanism

impl Eq for ScramMechanism

impl StructuralPartialEq for ScramMechanism