Struct PacketRef 

#[non_exhaustive]
pub struct PacketRef<'a> {
    pub track_id: u32,
    pub pts: Timestamp,
    pub dts: Timestamp,
    pub dur: Duration,
    pub trim_start: Duration,
    pub trim_end: Duration,
    pub data: &'a [u8],
}

A non-owning equivalent to Packet.

PacketRef is the zero-copy, non-owning, equivalent of Packet. It is particularly useful when packet data is already residing in an application-managed fixed buffer or when data is passed in from external environments like C/C++ via FFI. This allows decoders to process the data directly without forcing a heap allocation and deep copy.

See Packet for more details on the various timing and implementation details.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

track_id: u32

The track ID of the track this packet belongs to.

pts: Timestamp

The presentation timestamp (PTS) of the packet in TimeBase units.+

This is the time relative to the start of the media that the decoded packet should be presented to the user.

dts: Timestamp

The decode timestamp (DTS) of the packet in TimeBase units.

This is the time relative to the start of the media that the packet should be decoded.

dur: Duration

The duration of all valid frames in the packet in TimeBase units.

This duration excludes any delay or padding frames that may be produced by the decoder. Generally, delay or padding frames should not be presented to the user.

trim_start: Duration

The duration of decoded frames that should be trimmed from the start of the decoded buffer to remove encoder delay.

trim_end: Duration

The duration of decoded frames that should be trimmed from the end of the decoded buffer to remove encoder padding.

data: &'a [u8]

The packet data buffer.

Implementations

impl<'a> PacketRef<'a>

pub fn new(track_id: u32, pts: Timestamp, dur: Duration, data: &'a [u8]) -> Self

Create a new untrimmed PacketRef.

The data slice can be constructed directly from a fixed-size buffer, or from raw FFI pointers (e.g., a C++ std::vector payload) using std::slice::from_raw_parts.

pub const fn block_dur(&self) -> Duration

Get the duration of all decoded frames in the packet in TimeBase units.

pub fn as_buf_reader(&self) -> BufReader<'_>

Get a BufReader to read the packet data buffer sequentially.

Trait Implementations

impl<'a> Clone for PacketRef<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PacketRef<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a Packet> for PacketRef<'a>

fn from(packet: &'a Packet) -> Self

Converts to this type from the input type.

impl<'a> Copy for PacketRef<'a>