Enum StreamPacket 

pub enum StreamPacket {
    Pcm(PcmPacket),
    Midi(MidiPacket),
    Diagnostic(StreamDiagnostic),
    Data(DataPacket),
}

Umbrella over every payload kind a stream envelope can carry.

Each variant maps to a StreamMedia kind and to a stream/packet/* tagged Expr map. TryFrom<Expr> reconstructs a packet from that encoding.

Variants

Pcm(PcmPacket)

Real-time PCM audio frames.

Midi(MidiPacket)

Timed MIDI events.

Diagnostic(StreamDiagnostic)

In-band diagnostic message.

Data(DataPacket)

Opaque application-defined data.

Implementations

impl StreamPacket

pub fn media(&self) -> StreamMedia

Returns the StreamMedia kind this payload belongs to.

pub fn data(kind: Symbol, payload: Expr) -> Self

Builds a StreamPacket::Data payload from a kind symbol and payload expression.

pub fn model_event(payload: Expr) -> Self

Builds a stream/data/model-event data packet around payload.

pub fn rank_frontier(payload: Expr) -> Self

Builds a stream/data/rank-frontier data packet around payload.

pub fn to_expr(&self) -> Expr

Encodes the packet as its variant’s stream/packet/* Expr map.

pub fn intern_ref(&self, cx: &mut Cx) -> Result<Ref>

Interns the packet’s encoded form into the runtime datum store and returns a content Ref to it.

The kernel owns the datum store and content-addressing; this turns the packet’s Expr encoding into an interned Datum.

Trait Implementations

impl Clone for StreamPacket

fn clone(&self) -> StreamPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamPacket

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

Formats the value using the given formatter.

impl Eq for StreamPacket

impl PartialEq for StreamPacket

fn eq(&self, other: &StreamPacket) -> 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 StreamPacket

impl TryFrom<Expr> for StreamPacket

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.