Struct stun_rs::MessageType

pub struct MessageType { /* private fields */ }

The message type defines the message class (request, success response, error response, or indication) and the message method (the primary function) of the STUN message. Although there are four message classes, there are only two types of transactions in STUN: request/response transactions (which consist of a request message and a response message) and indication transactions (which consist of a single indication message). Response classes are split into error and success responses to aid in quickly processing the STUN message.

Examples

 let msg_type = MessageType::new(BINDING, MessageClass::SuccessResponse);
 assert_eq!(msg_type.as_u16(), 0x0101);
 assert_eq!(msg_type.method(), BINDING);
 assert_eq!(msg_type.class(), MessageClass::SuccessResponse);

Implementations

impl MessageType

pub fn new(method: MessageMethod, class: MessageClass) -> Self

Creates a new message type.

Arguments:

• method- the message method.
• class - The message class.

pub fn class(&self) -> MessageClass

Returns the message class.

pub fn method(&self) -> MessageMethod

Returns the message method

pub fn as_u16(&self) -> u16

Returns the u16 representation of this MessageType

Trait Implementations

impl Clone for MessageType

fn clone(&self) -> MessageType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageType

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

Formats the value using the given formatter.

impl From<&[u8; 2]> for MessageType

fn from(value: &[u8; 2]) -> Self

Converts to this type from the input type.

impl From<u16> for MessageType

fn from(value: u16) -> Self

Converts to this type from the input type.

impl PartialEq for MessageType

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

impl Eq for MessageType

impl StructuralPartialEq for MessageType