Struct TrackProducer 

pub struct TrackProducer { /* private fields */ }

A producer for a track, used to create new groups.

Implementations

impl TrackProducer

pub fn new(info: Track) -> TrackProducer

Build a producer for the given track metadata. Prefer Track::produce.

pub fn create_group(&mut self, info: Group) -> Result<GroupProducer, Error>

Create a new group with the given sequence number.

pub fn append_group(&mut self) -> Result<GroupProducer, Error>

Create a new group with the next sequence number.

pub fn write_frame<B>(&mut self, frame: B) -> Result<(), Error>

where B: Into<Bytes>,

Create a group with a single frame.

pub fn finish(&mut self) -> Result<(), Error>

Mark the track as finished after the last appended group.

Sets the final sequence to one past the current max_sequence. No new groups at or above this sequence can be appended. NOTE: Old groups with lower sequence numbers can still arrive.

pub fn finish_at(&mut self, sequence: u64) -> Result<(), Error>

Mark the track as finished at an exact final sequence.

The caller must pass the current max_sequence exactly. Freezes the final boundary at one past the current max_sequence. No new groups at or above that sequence can be created. NOTE: Old groups with lower sequence numbers can still arrive.

pub fn abort(&mut self, err: Error) -> Result<(), Error>

Abort the track with the given error.

Child groups are independent and must be aborted separately if desired; existing group consumers can still finish reading any groups that were already created.

pub fn consume(&self) -> TrackConsumer

Create a new consumer for the track, starting at the beginning.

pub async fn unused(&self) -> Result<(), Error>

Block until there are no active consumers.

pub async fn used(&self) -> Result<(), Error>

Block until there is at least one active consumer.

pub async fn closed(&self) -> Error

Block until the track is closed or aborted, returning the cause.

pub fn is_closed(&self) -> bool

Return true if the track has been closed.

pub fn is_clone(&self, other: &TrackProducer) -> bool

Return true if this is the same track.

Trait Implementations

impl Clone for TrackProducer

fn clone(&self) -> TrackProducer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for TrackProducer

type Target = Track

The resulting type after dereferencing.

fn deref(&self) -> &<TrackProducer as Deref>::Target

Dereferences the value.

impl From<Track> for TrackProducer

fn from(info: Track) -> TrackProducer

Converts to this type from the input type.