Struct StreamEdge 

pub struct StreamEdge { /* private fields */ }

A typed, rate-contracted port carrying envelopes between sites.

An edge names its port, the RateContract (and thus clock domain) it must honor, the stream StreamMetadata flowing across it, and any envelopes already buffered on it.

Implementations

impl StreamEdge

pub fn new( port: Symbol, rate_contract: RateContract, metadata: StreamMetadata, ) -> Self

Creates an empty edge for port under the given rate contract and metadata.

pub fn with_envelopes(self, envelopes: Vec<StreamEnvelope>) -> Self

Returns the edge with its buffered envelopes replaced.

pub fn port(&self) -> &Symbol

Returns the port symbol naming this edge.

pub fn rate_contract(&self) -> RateContract

Returns the rate contract this edge must honor.

pub fn metadata(&self) -> &StreamMetadata

Returns the metadata of the stream flowing across this edge.

pub fn envelopes(&self) -> &[StreamEnvelope]

Returns the envelopes currently buffered on this edge.

pub fn result_envelope( &self, sequence: u64, payload: Expr, ) -> Result<StreamEnvelope>

Builds a site-result data envelope for this edge.

Wraps payload in a stream/data packet sequenced at sequence under a memory-local transport profile, using this edge’s metadata.

Trait Implementations

impl Clone for StreamEdge

fn clone(&self) -> StreamEdge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEdge

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

Formats the value using the given formatter.

impl Eq for StreamEdge

impl PartialEq for StreamEdge

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