Struct stun_codec::AttributeType

pub struct AttributeType(_);

Attribute type.

Attributes are divided into two types: comprehension-required and comprehension-optional. STUN agents can safely ignore comprehension-optional attributes they don't understand, but cannot successfully process a message if it contains comprehension-required attributes that are not understood.

RFC 5389 -- 5. Definitions

---

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; STUN attribute types in the range 0x8000 - 0xFFFF are considered comprehension-optional.

RFC 5389 -- 18.2. STUN Attribute Registry

Methods

impl AttributeType

pub fn new(codepoint: u16) -> Self

Makes a new Type instance which corresponding to codepoint.

pub fn as_u16(self) -> u16

Returns the attribute codepoint corresponding this instance.

pub fn is_comprehension_required(self) -> bool

Returns true if this is a comprehension-required type.

pub fn is_comprehension_optional(self) -> bool

Returns true if this is a comprehension-optional type.

Trait Implementations

impl Debug for AttributeType

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

Formats the value using the given formatter.

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 Copy for AttributeType

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: &AttributeType) -> bool

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

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

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

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

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

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

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialEq 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: &AttributeType) -> bool

This method tests for !=.

impl Eq for AttributeType

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,

Feeds a slice of this type into the given [Hasher].

impl From<u16> for AttributeType

fn from(f: u16) -> Self

Performs the conversion.