Enum StreamControl 

pub enum StreamControl {
    Open {
        stream_id: Symbol,
        metadata: StreamMetadata,
    },
    Next {
        stream_id: Symbol,
        limit: Option<u64>,
    },
    Push {
        stream_id: Symbol,
        envelope: Box<StreamEnvelope>,
    },
    Close {
        stream_id: Symbol,
    },
    Cancel {
        stream_id: Symbol,
    },
    Stats {
        stream_id: Symbol,
    },
    Metadata {
        stream_id: Symbol,
    },
    Fault {
        stream_id: Symbol,
        fault: StreamFaultSpec,
    },
}

Control-plane operation exchanged over remote stream-fabric frames.

Each variant names one action a peer can take on a placed stream – opening it, pulling the next chunk, pushing an envelope, ending it, or reporting a fault – so the location-transparent eval surface can drive a remote stream without exposing transport-specific APIs. A StreamControl round-trips through the shared Expr graph (see StreamControl::to_expr and the TryFrom<Expr> impl) and is carried by stream_control_frame_from_control.

Variants

Open

Open a stream with the given identity and StreamMetadata.

Fields

stream_id: Symbol

Identifier of the stream being opened.

metadata: StreamMetadata

Declared metadata (media, direction, clock domain, buffer policy).

Next

Request the next chunk(s), bounded by an optional element limit.

Fields

stream_id: Symbol

Identifier of the stream being pulled.

limit: Option<u64>

Maximum number of elements to return, or None for unbounded.

Push

Push one stream envelope toward the peer.

Fields

stream_id: Symbol

Identifier of the stream being pushed to.

envelope: Box<StreamEnvelope>

Boxed envelope carrying the packet, ticks, and transport profile.

Close

Close a stream cleanly once production is finished.

Fields

stream_id: Symbol

Identifier of the stream being closed.

Cancel

Cancel a stream early, abandoning any remaining production.

Fields

stream_id: Symbol

Identifier of the stream being cancelled.

Stats

Request runtime statistics for a stream.

Fields

stream_id: Symbol

Identifier of the stream being queried.

Metadata

Request the metadata table for a stream.

Fields

stream_id: Symbol

Identifier of the stream being queried.

Fault

Report a fault against a stream.

Fields

stream_id: Symbol

Identifier of the faulting stream.

fault: StreamFaultSpec

Fault kind and occurrence count.

Implementations

impl StreamControl

pub fn operation(&self) -> Symbol

Returns the operation symbol naming this control variant.

pub fn required_capability(&self) -> CapabilityName

Returns the capability a peer must hold to perform this control action.

pub fn stream_id(&self) -> &Symbol

Returns the stream identifier targeted by this control action.

pub fn to_expr(&self) -> Expr

Encodes this control action as a stream data packet Expr.

The inverse is the TryFrom<Expr> impl, which reparses the packet back into a StreamControl.

Trait Implementations

impl Clone for StreamControl

fn clone(&self) -> StreamControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamControl

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

Formats the value using the given formatter.

impl Eq for StreamControl

impl PartialEq for StreamControl

fn eq(&self, other: &StreamControl) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamControl

impl TryFrom<Expr> for StreamControl

type Error = Error

The type returned in the event of a conversion error.

fn try_from(expr: Expr) -> Result<Self>

Performs the conversion.