Struct AttributeType

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

The type of an Attribute in a STUN Message

Implementations

impl AttributeType

pub fn add_name(self, name: &'static str)

Add the name for a particular AttributeType for formatting purposes.

pub const fn new(val: u16) -> Self

Create a new AttributeType from an existing value

Note: the value passed in is not encoded as in a stun message

Examples

assert_eq!(AttributeType::new(0x123).value(), 0x123);

pub fn value(&self) -> u16

Return the integer value of this AttributeType

Note: the value returned is not encoded as in a stun message

Examples

assert_eq!(AttributeType::new(0x123).value(), 0x123);

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

Returns a human readable name of this AttributeType or “unknown”

Examples

assert_eq!(XorMappedAddress::TYPE.name(), "XOR-MAPPED-ADDRESS");

pub fn comprehension_required(self) -> bool

Check if comprehension is required for an AttributeType. All attribute values < 0x8000 require comprehension.

Examples

assert_eq!(AttributeType::new(0x0).comprehension_required(), true);
assert_eq!(AttributeType::new(0x8000).comprehension_required(), false);

Trait Implementations

impl Clone for AttributeType

fn clone(&self) -> AttributeType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttributeType

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

Formats the value using the given formatter.

impl Display for AttributeType

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

Formats the value using the given formatter.

impl From<AttributeType> for u16

fn from(f: AttributeType) -> Self

Converts to this type from the input type.

impl From<u16> for AttributeType

fn from(f: u16) -> Self

Converts to this type from the input type.

impl Hash for AttributeType

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 AttributeType

fn cmp(&self, other: &AttributeType) -> 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 AttributeType

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

fn partial_cmp(&self, other: &AttributeType) -> 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 AttributeType

impl Eq for AttributeType

impl StructuralPartialEq for AttributeType