Struct StunMessageBuilder

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

The StunMessageBuilder ease the creation of a StunMessage

Examples

 // Create a SUN request message with a random transaction ID.
 let message = StunMessageBuilder::new(
     BINDING,
     MessageClass::Request,
 )
 .with_attribute(UserName::try_from("test-username")?)
 .with_attribute(Software::new("test-software")?)
 .build();

 let username = message.get::<UserName>()
   .ok_or("UserName attriute not found")?
   .as_user_name()?;
 assert_eq!(username, "test-username");

 let software = message.get::<Software>()
   .ok_or("Software attriute not found")?
   .as_software()?;
 assert_eq!(software, "test-software");

 // Nonce attribute must return None
 assert!(message.get::<Nonce>().is_none());

Implementations

impl StunMessageBuilder

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

Creates a new builder.

Arguments:

• method - Message method.
• class - Message class.

pub fn with_transaction_id(self, transaction_id: TransactionId) -> Self

Creates a STUN message using an specific transaction ID. If no TransactionId is specified, a random one will be used

pub fn with_attribute<T>(self, attribute: T) -> Self

where T: Into<StunAttribute>,

Adds an attribute to the message.

pub fn build(self) -> StunMessage

Creates the STUN message.

Trait Implementations

impl Debug for StunMessageBuilder

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

Formats the value using the given formatter.