Struct discortp::rtcp::RtcpPacket

pub struct RtcpPacket<'p> { /* fields omitted */ }

A structure enabling manipulation of on the wire packets

Methods

impl<'a> RtcpPacket<'a>

pub fn new<'p>(packet: &'p [u8]) -> Option<RtcpPacket<'p>>

Constructs a new RtcpPacket. If the provided buffer is less than the minimum required packet size, this will return None.

pub fn owned(packet: Vec<u8>) -> Option<RtcpPacket<'static>>

Constructs a new RtcpPacket. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the RtcpPacket will own its own data and the underlying buffer will be dropped when the RtcpPacket is.

pub fn to_immutable<'p>(&'p self) -> RtcpPacket<'p>

Maps from a RtcpPacket to a RtcpPacket

pub fn consume_to_immutable(self) -> RtcpPacket<'a>

Maps from a RtcpPacket to a RtcpPacket while consuming the source

pub const fn minimum_packet_size() -> usize

The minimum size (in bytes) a packet of this type can be. It's based on the total size of the fixed-size fields.

pub fn packet_size(_packet: &Rtcp) -> usize

The size (in bytes) of a Rtcp instance when converted into a byte-array

pub fn get_version(&self) -> u2

Get the version field.

pub fn get_padding(&self) -> u1

Get the padding field.

pub fn get_rx_report_count(&self) -> u5

Get the rx_report_count field.

pub fn get_packet_type(&self) -> RtcpType

Get the value of the packet_type field

pub fn get_pkt_length(&self) -> u16be

Get the pkt_length field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_ssrc(&self) -> u32be

Get the ssrc field. This field is always stored big-endian within the struct, but this accessor returns host order.

Trait Implementations

impl<'p> Debug for RtcpPacket<'p>

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'p> FromPacket for RtcpPacket<'p>

type T = Rtcp

The type of the packet to convert from.

fn from_packet(&self) -> Rtcp

Converts a wire-format packet to #[packet] struct format.

impl<'a> Packet for RtcpPacket<'a>

fn packet<'p>(&'p self) -> &'p [u8]

Retrieve the underlying buffer for the packet.

fn payload<'p>(&'p self) -> &'p [u8]

Retrieve the payload for the packet.

impl<'a> PacketSize for RtcpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<RtcpPacket<'p>> for RtcpPacket<'p>

fn eq(&self, other: &RtcpPacket<'p>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RtcpPacket<'p>) -> bool

This method tests for !=.

impl<'p> StructuralPartialEq for RtcpPacket<'p>