Struct discortp::rtp::RtpPacket

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

A structure enabling manipulation of on the wire packets

Methods

impl<'a> RtpPacket<'a>

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

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

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

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

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

Maps from a RtpPacket to a RtpPacket

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

Maps from a RtpPacket to a RtpPacket 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: &Rtp) -> usize

The size (in bytes) of a Rtp 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_extension(&self) -> u1

Get the extension field.

pub fn get_csrc_count(&self) -> u4

Get the csrc_count field.

pub fn get_marker(&self) -> u1

Get the marker field.

pub fn get_payload_type(&self) -> RtpType

Get the value of the payload_type field

pub fn get_sequence(&self) -> u16be

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

pub fn get_timestamp(&self) -> u32be

Get the timestamp 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 get_csrc_list_raw(&self) -> &[u8]

Get the raw &u8 value of the csrc_list field, without copying

pub fn get_csrc_list(&self) -> Vec<u32be>

Get the value of the csrc_list field (copies contents)

Trait Implementations

impl<'p> Debug for RtpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for RtpPacket<'p>

type T = Rtp

The type of the packet to convert from.

fn from_packet(&self) -> Rtp

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

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<RtpPacket<'p>> for RtpPacket<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for RtpPacket<'p>