Struct PasswordAlgorithm

pub struct PasswordAlgorithm(/* private fields */);

The PASSWORD-ALGORITHM attribute is present only in requests. It contains the algorithm that the server must use to derive a key from the long-term password.

Examples

 // Creates a MD5 password algorithm without parameters
 let attr = PasswordAlgorithm::new(Algorithm::from(AlgorithmId::MD5));
 assert_eq!(attr.algorithm(), AlgorithmId::MD5);
 assert_eq!(attr.parameters(), None);

 // Creates a custom password algorithm with parameters
 let params = [0x01, 0x02, 0x03, 0x04, 0x05];
 let algorithm = Algorithm::new(AlgorithmId::Unassigned(255), params.as_ref());
 let attr = PasswordAlgorithm::new(algorithm);
 assert_eq!(attr.algorithm(), AlgorithmId::Unassigned(255));
 assert_eq!(attr.parameters(), Some(params.as_ref()));

Implementations

impl PasswordAlgorithm

pub fn new(algorithm: Algorithm) -> Self

Creates a new PasswordAlgorithm attribute.

Attributes:

• algorithm - The Algorithm.
• value - Specific parameters for the algorithm, if any.

pub fn algorithm(&self) -> AlgorithmId

Returns the algorithm

pub fn parameters(&self) -> Option<&[u8]>

Returns the parameters required by the algorithm.

Trait Implementations

impl AsRef<Algorithm> for PasswordAlgorithm

fn as_ref(&self) -> &Algorithm

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PasswordAlgorithm

fn clone(&self) -> PasswordAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PasswordAlgorithm

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

Formats the value using the given formatter.

impl From<PasswordAlgorithm> for StunAttribute

fn from(value: PasswordAlgorithm) -> Self

Converts to this type from the input type.

impl PartialEq for PasswordAlgorithm

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

fn get_type() -> AttributeType

where Self: Sized,

Returns the STUN attribute type.

fn attribute_type(&self) -> AttributeType

Returns the STUN attribute type of this instance.

impl Eq for PasswordAlgorithm

impl StructuralPartialEq for PasswordAlgorithm