Struct stun_rs::MessageMethod

pub struct MessageMethod(_);

The STUN method is a 12 bits hex number in the range 0x000-0xFFF but valid values are defined in the range 0x00-0xFF. STUN methods in the range 0x000-0x07F are assigned by IETF Review RFC8126. STUN methods in the range 0x080-0x0FF are assigned by Expert Review.

Examples

 // Create a binding method
 let binding = MessageMethod::try_from(0x001)?;
 assert_eq!(binding.as_u16(), 0x001);
 // Binding request is within the range of valid values 0x00-0xFF
 assert!(binding.is_valid());

 // Create a custom method
 let method = MessageMethod::try_from(0x100)?;
 // This method is out of the range of valid values 0x00-0xFF
 assert!(!method.is_valid());

 // Creating a message method out of 12 bits range 0x000-0xFFF
 // will result in an error
 assert_eq!(MessageMethod::try_from(0x1000).expect_err("Error expected"), StunErrorType::InvalidParam);

Implementations

impl MessageMethod

pub fn as_u16(&self) -> u16

Returns the u16 representation of this message method.

pub fn is_valid(&self) -> bool

Returns true if the method is within the valid range 0x00-0xFF

Trait Implementations

impl Clone for MessageMethod

fn clone(&self) -> MessageMethod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageMethod

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

Formats the value using the given formatter.

impl Default for MessageMethod

fn default() -> MessageMethod

Returns the “default value” for a type.

impl PartialEq<MessageMethod> for MessageMethod

fn eq(&self, other: &MessageMethod) -> 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 TryFrom<u16> for MessageMethod

type Error = StunError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MessageMethod

impl Eq for MessageMethod

impl StructuralEq for MessageMethod

impl StructuralPartialEq for MessageMethod