Struct stun_types::message::MessageType

pub struct MessageType(/* private fields */);

The type of a Message. A combination of a MessageClass and a STUN method.

Implementations

impl MessageType

pub fn from_class_method(class: MessageClass, method: u16) -> Self

Create a new MessageType from the provided MessageClass and method

Examples

let mtype = MessageType::from_class_method(MessageClass::Indication, BINDING);
assert_eq!(mtype.has_class(MessageClass::Indication), true);
assert_eq!(mtype.has_method(BINDING), true);

pub fn class(self) -> MessageClass

Retrieves the class of a MessageType

Examples

let mtype = MessageType::from_class_method(MessageClass::Indication, BINDING);
assert_eq!(mtype.class(), MessageClass::Indication);

pub fn has_class(self, cls: MessageClass) -> bool

Returns whether class of a MessageType is equal to the provided MessageClass

Examples

let mtype = MessageType::from_class_method(MessageClass::Indication, BINDING);
assert!(mtype.has_class(MessageClass::Indication));

pub fn is_response(self) -> bool

Returns whether the class of a MessageType indicates a response Message

Examples

assert_eq!(MessageType::from_class_method(MessageClass::Indication, BINDING)
    .is_response(), false);
assert_eq!(MessageType::from_class_method(MessageClass::Request, BINDING)
    .is_response(), false);
assert_eq!(MessageType::from_class_method(MessageClass::Success, BINDING)
    .is_response(), true);
assert_eq!(MessageType::from_class_method(MessageClass::Error, BINDING)
    .is_response(), true);

pub fn method(self) -> u16

Returns the method of a MessageType

Examples

let mtype = MessageType::from_class_method(MessageClass::Indication, BINDING);
assert_eq!(mtype.method(), BINDING);

pub fn has_method(self, method: u16) -> bool

Returns whether the method of a MessageType is equal to the provided value

Examples

let mtype = MessageType::from_class_method(MessageClass::Indication, BINDING);
assert_eq!(mtype.has_method(BINDING), true);

pub fn to_bytes(self) -> Vec<u8>

Convert a MessageType to network bytes

pub fn from_bytes(data: &[u8]) -> Result<Self, StunParseError>

Convert a set of network bytes into a MessageType or return an error

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 Display for MessageType

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

Formats the value using the given formatter.

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 TryFrom<&[u8]> for MessageType

type Error = StunParseError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MessageType

impl Eq for MessageType

impl StructuralPartialEq for MessageType