Struct discortp::rtcp::MutableRtcpPacket

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

A structure enabling manipulation of on the wire packets

Methods

impl<'a> MutableRtcpPacket<'a>

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

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

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

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

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

Maps from a MutableRtcpPacket to a RtcpPacket

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

Maps from a MutableRtcpPacket 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 populate(&mut self, packet: &Rtcp)

Populates a RtcpPacket using a Rtcp structure

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.

pub fn set_version(&mut self, val: u2)

Set the version field.

pub fn set_padding(&mut self, val: u1)

Set the padding field.

pub fn set_rx_report_count(&mut self, val: u5)

Set the rx_report_count field.

pub fn set_packet_type(&mut self, val: RtcpType)

Set the value of the packet_type field.

pub fn set_pkt_length(&mut self, val: u16be)

Set the pkt_length field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_ssrc(&mut self, val: u32be)

Set the ssrc field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_payload(&mut self, vals: &[u8])

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableRtcpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableRtcpPacket<'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> MutablePacket for MutableRtcpPacket<'a>

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

Retreive the underlying, mutable, buffer for the packet.

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

Retreive the mutable payload for the packet.

fn clone_from<T>(&mut self, other: &T) where
    T: Packet, 

Initialize this packet by cloning another.

impl<'a> Packet for MutableRtcpPacket<'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 MutableRtcpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableRtcpPacket<'p>> for MutableRtcpPacket<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for MutableRtcpPacket<'p>