Struct SourceHandle 

pub struct SourceHandle { /* private fields */ }

A clonable handle a source’s reader task uses to inject frames into the pipeline head. Thin wrapper over the PipelineTask head queue so transport authors call emit/end instead of touching the raw channel.

Implementations

impl SourceHandle

pub fn new(head: UnboundedSender<Frame>) -> Self

Wrap a PipelineTask::queue_sender handle.

pub fn emit(&self, frame: Frame) -> Result<(), Frame>

Inject one frame at the pipeline head (flows downstream). Returns Err if the pipeline has shut down (the reader should then stop). Mirrors pipecat BaseInputTransport.push_frame from the reader task.

pub fn end(&self)

Request a graceful drain: inject a downstream End at the head so every processor (incl. the internal Source) flushes and the task winds down. Idempotent and a no-op once the pipeline is gone.

pub fn cancel(&self, reason: Option<String>)

Request an immediate, no-flush teardown: inject a downstream Cancel.

Trait Implementations

impl Clone for SourceHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.