Skip to main content

PrerollContext

Struct PrerollContext 

Source
pub struct PrerollContext { /* private fields */ }
Expand description

Shared completion state for one preroll pass.

Implementations§

Source§

impl PrerollContext

Source

pub fn new(terminals: impl IntoIterator<Item = ElementId>) -> Self

Creates a preroll that completes once every supplied terminal ID is marked ready (or EOS-equivalent).

Source

pub fn for_seek( terminals: impl IntoIterator<Item = ElementId>, target: Duration, ) -> Self

Creates a seek preroll whose decoded timing gates should discard samples before target while decoding forward from the landed keyframe.

Source

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

Exact requested position for seek preroll, or None for ordinary first-sample preroll.

Source

pub fn mark_ready(&self, terminal: ElementId)

Marks one expected terminal’s first valid sample as ready.

Source

pub fn mark_eos(&self, terminal: ElementId)

EOS means this terminal cannot produce a sample and therefore must not leave the whole preroll waiting forever.

Source

pub fn mark_departed(&self, terminal: ElementId)

Stops expecting a terminal that has left the graph.

The expected set is fixed when the seek starts, but the topology is not: detaching a Tee branch mid-seek removes its terminal without removing the obligation to hear from it, and the wait would run to its timeout for a sample nobody is left to produce. Like EOS, this is “cannot produce one”, not “produced one”.

Source

pub fn is_ready(&self, terminal: ElementId) -> bool

Whether this one terminal has already taken its preroll sample.

A terminal stops accepting as soon as it is ready, not when the whole preroll is. Waiting for the others would let a branch that reached the target first keep consuming for as long as the slowest branch takes — which is how the two streams end up at different positions when preroll finally completes.

Source

pub fn is_complete(&self) -> bool

Returns whether every expected terminal has completed this preroll.

Source

pub fn cancel(&self)

Cancels a pending wait, used by stop and failed seek recovery.

Source

pub fn wait(&self, timeout: Duration) -> Result<(), PrerollError>

Waits until every expected terminal is ready, cancellation is requested, or timeout expires.

Trait Implementations§

Source§

impl Debug for PrerollContext

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CryptoSafe for T
where T: Send + Sync + Debug,

Source§

impl<T> CryptoSafe for T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more