Struct ChannelData

pub struct ChannelData<'a> { /* private fields */ }

A ChannelData message.

Implementations

impl<'a> ChannelData<'a>

pub fn new(id: u16, data: &'a [u8]) -> Self

Construct a new ChannelData with the provided identifer and byte sequence.

pub fn id(&self) -> u16

The channel identifier stored in this piece of data.

pub fn data(&self) -> &[u8]

The sequence of bytes in this message.

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

Parse a sequence of bytes into a ChannelData. Returns appropriate errors on failure.

Examples

let data = [4; 3];
let channel = ChannelData::new(0x4000, &data);
let mut output = [0; 7];
assert_eq!(7, channel.write_into_unchecked(&mut output));
let parsed = ChannelData::parse(&output).unwrap();
assert_eq!(parsed.id(), channel.id());
assert_eq!(parsed.data(), channel.data());

pub fn parse_header(data: &[u8]) -> Result<(u16, usize), StunParseError>

Parse the header of an ChannelData returning the channel ID and the length of the contained data (without the 4 byte header).

Examples

let data = [4; 3];
let channel = ChannelData::new(0x4000, &data);
let mut output = [0; 7];
assert_eq!(7, channel.write_into_unchecked(&mut output));
let (id, len) = ChannelData::parse_header(&output).unwrap();
assert_eq!(id, channel.id());
assert_eq!(len, 3);

pub fn write_into_unchecked(self, dest: &mut [u8]) -> usize

Write this ChannelData into the provided destination slice.

The destination slice must have size ChannelData::data().len() + 4.

Trait Implementations

impl AsRef<[u8]> for ChannelData<'_>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for ChannelData<'a>

fn clone(&self) -> ChannelData<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ChannelData<'a>

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

Formats the value using the given formatter.

impl Display for ChannelData<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq for ChannelData<'a>

fn eq(&self, other: &ChannelData<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for ChannelData<'a>

impl<'a> Eq for ChannelData<'a>

impl<'a> StructuralPartialEq for ChannelData<'a>