Skip to main content

ChainBuilder

Struct ChainBuilder 

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

Builds one chain segment (a run of elements that all execute on the same thread). Call ChainBuilder::queue to close the current segment behind a Queue and start a new one on its own worker thread.

Because each element needs a handle to its downstream to be constructed, the chain is assembled back-to-front: elements are collected in call order, then folded right-to-left starting from the terminal Sink at ChainBuilder::to time.

Implementations§

Source§

impl ChainBuilder

Source

pub fn new(context: Arc<Context>) -> Self

Starts a detached branch plan. Prefer Context::branch at call sites; it makes the owning pipeline explicit without cloning the context manually.

Source

pub fn pipe<T: Filter + 'static>(self, element: T) -> Self

Adds a single-output Filter (decoder, encoder, filter, …) that receives via Sink and produces through its own (single) src pad. It runs on the same thread as whatever is upstream of it — direct function call, no queue.

Source

pub fn queue(self, name: impl Into<String>, capacity: usize) -> Self

Introduces a thread boundary (blocking when full — see OverflowPolicy::Block): everything added after this runs on its own worker thread instead of the thread that feeds this queue.

Source

pub fn queue_with_policy( self, name: impl Into<String>, capacity: usize, policy: OverflowPolicy, ) -> Self

Same as ChainBuilder::queue, but lets you choose what happens when the queue is full (e.g. OverflowPolicy::DropNewest for a live source that shouldn’t stall upstream).

Source

pub fn to(self, terminal: Box<dyn Sink>) -> Result<DetachedBranch>

Terminates the chain with a Sink (muxer, file sink, …) and assembles everything into a single Box<dyn Sink> ready to be linked into a source’s src pad. The terminal’s own Element::name() is what shows up on the bus when it reports EOS.

Source

pub fn build(self, terminal: Box<dyn Sink>) -> Result<DetachedBranch>

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
§

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

§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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