Enum SystemFrame 

pub enum SystemFrame {
    Start,
    Stop,
    Interrupt,
    Error {
        message: Arc<str>,
        fatal: bool,
    },
}

System frames: lifecycle, control, and errors.

These are bidirectional: Interrupt and Start/Stop travel downstream; Error typically travels upstream. Immutable once constructed.

A frame belongs on this lane only if it must hop the queue — be handled ahead of the data backlog instead of in sequence with it. That is a deliberately small set (a barge-in Interrupt, Start/Stop lifecycle, an Error), and the bar is high. Anything that marks a point in the stream — a state change that must stay ordered with the media it annotates, like the voice-activity edges (SpeechStarted / SpeechStopped) or a future turn boundary — instead rides the data lane as a DataFrame, where frames keep their arrival order. When in doubt, use the data lane.

Variants

Start

Pipeline is starting; stages should initialise any runtime state.

Stop

Graceful shutdown; stages should flush and clean up.

Interrupt

User barged in; stages should discard in-flight work and reset.

Error

An error propagated through the pipeline.

Fields

message: Arc<str>

Human-readable description of the error.

fatal: bool

Whether the error is unrecoverable and the pipeline should shut down.

Trait Implementations

impl Clone for SystemFrame

fn clone(&self) -> SystemFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemFrame

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

Formats the value using the given formatter.