Skip to main content

BusEvent

Enum BusEvent 

Source
#[non_exhaustive]
pub enum BusEvent { Eos { element_type: ElementType, name: Arc<str>, }, Error { element_type: ElementType, name: Arc<str>, error: Error, }, Dropped { element_type: ElementType, name: Arc<str>, }, Seeked { element_type: ElementType, name: Arc<str>, requested: Duration, landed: Duration, }, }
Expand description

Marked #[non_exhaustive]: this grows as elements gain conditions worth reporting, and a caller acting on Eos/Error should not stop compiling because some unrelated element learned to report a stall. Within this crate the attribute has no effect, so Bus::post and BusReceiver::log_events still fail to compile until they handle a new variant — the completeness check stays where it belongs.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Eos

An element completed ordered end-of-stream processing.

Fields

§element_type: ElementType

Built-in kind of the element that completed.

§name: Arc<str>

Caller-selected instance name of the element that completed.

§

Error

An element encountered a failure that could not be returned through the synchronous call stack.

Fields

§element_type: ElementType

Built-in kind of the element reporting the failure.

§name: Arc<str>

Caller-selected instance name of the element reporting the failure.

§error: Error

Typed crate or component error reported by the element.

§

Dropped

A Queue with OverflowPolicy::DropNewest dropped a buffer because it was full.

Fields

§element_type: ElementType

Built-in kind of the queue that dropped the buffer.

§name: Arc<str>

Caller-selected instance name of the queue that dropped the buffer.

§

Seeked

Posted by crate::control::drain_control once crate::element::SourceElement::seek returns — requested is1 whatever crate::pipeline::Pipeline::seek was called with; landed is where the source actually ended up, which the source itself has to resolve (e.g. FileDemuxer can only reposition to a keyframe at or before requested, never exactly on top of an arbitrary timestamp — see its seek impl). Watch this instead of assuming requested took effect verbatim.

Fields

§element_type: ElementType

Built-in kind of the source that performed the seek.

§name: Arc<str>

Caller-selected instance name of the source that performed the seek.

§requested: Duration

Absolute media position requested by crate::pipeline::Pipeline::seek.

§landed: Duration

Absolute media position at which the source actually resumed.

Trait Implementations§

Source§

impl Debug for BusEvent

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