Struct stun_rs::attributes::AttributeType

pub struct AttributeType(_);

A STUN attribute type is a hex number in the range 0x0000-0xFFFF. STUN attribute types in the range 0x0000-0x7FFF are considered comprehension-required.

Examples

 let attr_type = AttributeType::from(0x0008);
 assert_eq!(attr_type.as_u16(), 0x0008);
 // This is a comprehension required attribute
 assert!(attr_type.is_comprehension_required());
 // This is not a comprehension optional attribute
 assert!(!attr_type.is_comprehension_optional());

Implementations

impl AttributeType

pub fn new(attr_type: u16) -> Self

Creates a new AttributeType

pub fn as_u16(&self) -> u16

Return the u16 representation of this attribute type

pub fn is_comprehension_required(&self) -> bool

Returns true if this is a comprehension required attribute

pub fn is_comprehension_optional(self) -> bool

Returns true if this is a comprehension optional attribute

Trait Implementations

impl Clone for AttributeType

fn clone(&self) -> AttributeType

Returns a copy 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(val: AttributeType) -> Self

Converts to this type from the input type.

impl From<u16> for AttributeType

fn from(val: 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) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AttributeType> for AttributeType

fn eq(&self, other: &AttributeType) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<AttributeType> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 StructuralEq for AttributeType

impl StructuralPartialEq for AttributeType