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) -> Self

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

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

Create a new group with the given sequence number.

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

Create a new group with the next sequence number.

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

Create a group with a single frame.

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

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<()>

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<()>

Abort the track with the given error.

Drops the cached groups so a stale TrackConsumer can’t pin them (and their frame buffers) in memory forever. Consumers that haven’t drained yet surface the abort error instead of the leftover cache. Child groups are independent: a consumer that already pulled a GroupConsumer keeps its own handle and can finish reading it.

pub fn consume(&self) -> TrackConsumer

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

pub fn name(&self) -> &str

The track name.

pub fn demand(&self) -> TrackDemand

A cloneable watch-only handle to subscriber demand.

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

Block until there are no active consumers.

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

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: &Self) -> bool

Return true if this is the same track.

Trait Implementations

impl Clone for TrackProducer

fn clone(&self) -> Self

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) -> &Self::Target

Dereferences the value.

impl Drop for TrackProducer

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<Track> for TrackProducer

fn from(info: Track) -> Self

Converts to this type from the input type.