Skip to main content

MutableReportBlockPacket

Struct MutableReportBlockPacket 

Source
pub struct MutableReportBlockPacket<'p> { /* private fields */ }
Expand description

A structure enabling manipulation of on the wire packets

Implementations§

Source§

impl<'a> MutableReportBlockPacket<'a>

Source

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

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

Source

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

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

Source

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

Maps from a MutableReportBlockPacket to a ReportBlockPacket

Source

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

Maps from a MutableReportBlockPacket to a ReportBlockPacket while consuming the source

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.

Source

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

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

Source

pub fn populate(&mut self, packet: &ReportBlock)

Populates a ReportBlockPacket using a ReportBlock structure

Source

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.

Source

pub fn get_fraction_lost(&self) -> u8

Get the fraction_lost field.

Source

pub fn get_cumulative_pkts_lost(&self) -> u24be

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

Source

pub fn get_cycles(&self) -> u16be

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

Source

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.

Source

pub fn get_interarrival_jitter(&self) -> u32be

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

Source

pub fn get_last_sr_timestamp(&self) -> u32be

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

Source

pub fn get_last_sr_delay(&self) -> u32be

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

Source

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.

Source

pub fn set_fraction_lost(&mut self, val: u8)

Set the fraction_lost field.

Source

pub fn set_cumulative_pkts_lost(&mut self, val: u24be)

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

Set the value of the payload field (copies contents)

Trait Implementations§

Source§

impl<'p> Debug for MutableReportBlockPacket<'p>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'p> FromPacket for MutableReportBlockPacket<'p>

Source§

type T = ReportBlock

The type of the packet to convert from.
Source§

fn from_packet(&self) -> ReportBlock

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

impl<'a> MutablePacket for MutableReportBlockPacket<'a>

Source§

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

Retrieve the underlying, mutable, buffer for the packet.
Source§

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

Retrieve the mutable payload for the packet.
Source§

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

Initialize this packet by cloning another.
Source§

impl<'a> Packet for MutableReportBlockPacket<'a>

Source§

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

Retrieve the underlying buffer for the packet.
Source§

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

Retrieve the payload for the packet.
Source§

impl<'a> PacketSize for MutableReportBlockPacket<'a>

Source§

fn packet_size(&self) -> usize

Get the calculated size of the packet.
Source§

impl<'p> PartialEq for MutableReportBlockPacket<'p>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<'p> StructuralPartialEq for MutableReportBlockPacket<'p>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.