Struct stun_codec::rfc5766::attributes::ChannelNumber

pub struct ChannelNumber(_);

CHANNEL-NUMBER attribute.

See RFC 5766 -- 14.1. CHANNEL-NUMBER about this attribute.

Implementations

impl ChannelNumber

pub const CODEPOINT: u16

The codepoint of the type of the attribute.

pub const MIN: u16

Minimum channel number.

pub const MAX: u16

Maximum channel number.

pub fn new(n: u16) -> Result<Self>

Makes a new ChannelNumber instance.

Errors

If n is not a number between ChannelNumber::MIN and ChannelNumber::MAX, this will return an ErrorKind::InvalidInput error.

pub fn value(self) -> u16

Returns the channel number indicated by the attribute.

pub fn min() -> Self

Returns the minimum channel number.

pub fn max() -> Self

Returns the maximum channel number.

pub fn wrapping_increment(self) -> Self

Wrapping incrementation.

Trait Implementations

impl Attribute for ChannelNumber

type Decoder = ChannelNumberDecoder

The decoder of the value part of the attribute.

type Encoder = ChannelNumberEncoder

The encoder of the value part of the attribute.

fn get_type(&self) -> AttributeType

Returns the type of the attribute.

fn before_encode<A: Attribute>(&mut self, message: &Message<A>) -> Result<()>

This method is called before encoding the attribute.

fn after_decode<A: Attribute>(&mut self, message: &Message<A>) -> Result<()>

This method is called after decoding the attribute and before being appended to the given message.

impl Clone for ChannelNumber

fn clone(&self) -> ChannelNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelNumber

impl Debug for ChannelNumber

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

Formats the value using the given formatter.

impl Eq for ChannelNumber

impl From<ChannelNumber> for Attribute

fn from(f: ChannelNumber) -> Self

Performs the conversion.

impl Hash for ChannelNumber

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ChannelNumber

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ChannelNumber> for ChannelNumber

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

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

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

This method tests for !=.

impl PartialOrd<ChannelNumber> for ChannelNumber

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ChannelNumber

impl StructuralPartialEq for ChannelNumber

impl TryAsRef<ChannelNumber> for Attribute

fn try_as_ref(&self) -> Option<&ChannelNumber>

Attempts to convert self to a reference to T.