Struct StreamMetadata 

pub struct StreamMetadata { /* private fields */ }

Full identity of a stream: id, media kind, direction, clock, and buffer policy.

This is the value other libraries inspect to learn a stream’s shape, and the value publish_metadata_claims turns into runtime facts. It round-trips to and from an Expr map (table_expr/from_table_expr) and to constructor arguments (to_constructor_args/from_constructor_args).

Implementations

impl StreamMetadata

pub fn new( id: Symbol, media: StreamMedia, direction: StreamDirection, clock: Symbol, buffer: BufferPolicy, ) -> Self

Builds metadata from its id, media kind, direction, clock symbol, and buffer policy.

pub fn id(&self) -> &Symbol

Returns the stream’s identity symbol.

pub fn media(&self) -> StreamMedia

Returns the stream’s media kind.

pub fn direction(&self) -> StreamDirection

Returns the stream’s flow direction.

pub fn clock(&self) -> &Symbol

Returns the symbol naming the stream’s clock.

pub fn buffer(&self) -> &BufferPolicy

Returns the stream’s buffer policy.

pub fn subject_ref(&self) -> Ref

Returns the claim-store subject reference for this stream (its id as a symbol ref).

pub fn to_constructor_args(&self) -> Vec<Expr>

Encodes the metadata as the ordered constructor argument expressions accepted by from_constructor_args.

pub fn from_constructor_args(args: Vec<Expr>) -> Result<Self>

Rebuilds metadata from the five constructor argument expressions produced by to_constructor_args.

Returns an error when the argument count or any argument shape is wrong.

pub fn table_expr(&self) -> Expr

Encodes the metadata as a self-describing Expr map keyed by field name (kind, id, media, direction, clock, buffer).

pub fn from_table_expr(expr: &Expr) -> Result<Self>

Rebuilds metadata from the Expr map produced by table_expr.

Returns an error when the expression is not a map or a required field is missing or malformed.

Trait Implementations

impl Clone for StreamMetadata

fn clone(&self) -> StreamMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMetadata

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

Formats the value using the given formatter.

impl Eq for StreamMetadata

impl PartialEq for StreamMetadata

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