Struct DataTrackFrame 

pub struct DataTrackFrame { /* private fields */ }

A frame published on a data track, consisting of a payload and optional metadata.

Examples

Create a frame from a Vec payload:

let some_payload = vec![0xFA; 256];
let frame: DataTrackFrame = some_payload.into();

assert_eq!(frame.payload().len(), 256);

Implementations

impl DataTrackFrame

pub fn payload(&self) -> Bytes

Returns the frame’s payload.

pub fn user_timestamp(&self) -> Option<u64>

Returns the frame’s user timestamp, if one is associated.

pub fn duration_since_timestamp(&self) -> Option<Duration>

If the frame has a user timestamp, calculate how long has passed relative to the current system time.

If a timestamp is present, it is assumed it is a UNIX timestamp in milliseconds (as can be set with Self::with_user_timestamp_now on the publisher side). If the timestamp is invalid or not present, the result is none.

impl DataTrackFrame

pub fn new(payload: impl Into<Bytes>) -> Self

Creates a frame from the given payload.

pub fn with_user_timestamp(self, value: u64) -> Self

Associates a user timestamp with the frame.

pub fn with_user_timestamp_now(self) -> Self

Associates the current Unix timestamp (in milliseconds) with the frame.

Trait Implementations

impl Clone for DataTrackFrame

fn clone(&self) -> DataTrackFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataTrackFrame

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

Formats the value using the given formatter.

impl Default for DataTrackFrame

fn default() -> DataTrackFrame

Returns the “default value” for a type.

impl From<&'static [u8]> for DataTrackFrame

fn from(slice: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<Box<[u8]>> for DataTrackFrame

fn from(slice: Box<[u8]>) -> Self

Converts to this type from the input type.

impl From<Bytes> for DataTrackFrame

fn from(bytes: Bytes) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for DataTrackFrame

fn from(vec: Vec<u8>) -> Self

Converts to this type from the input type.