Struct StreamRecording 

pub struct StreamRecording { /* private fields */ }

A fully captured stream: its metadata plus every packet it produced.

A recording is the materialized, replayable form of a finished stream. It is produced by draining a Stream to done and can be replayed any number of times, seeked into, or serialized to a transport cassette.

Examples

use sim_kernel::{Expr, Symbol};
use sim_lib_stream_core::{
    BufferOverflowPolicy, BufferPolicy, StreamDirection, StreamItem, StreamMedia,
    StreamMetadata, StreamPacket,
};
use sim_lib_stream_combinators::{record_bang, Stream};

let metadata = StreamMetadata::new(
    Symbol::qualified("stream", "doc"),
    StreamMedia::Data,
    StreamDirection::Source,
    Symbol::qualified("clock", "doc"),
    BufferPolicy::bounded_with_overflow(8, BufferOverflowPolicy::DropNewest).unwrap(),
);
let item = StreamItem::new(StreamPacket::data(
    Symbol::qualified("stream/data", "model-event"),
    Expr::Nil,
));
let stream = Stream::pull(metadata, vec![item.clone()]);

let recording = record_bang(&stream).unwrap();
assert_eq!(recording.len(), 1);
assert_eq!(recording.replay().take_packets(8).unwrap(), vec![item]);

Implementations

impl StreamRecording

pub fn new(metadata: StreamMetadata, items: Vec<StreamItem>) -> Self

Builds a recording from explicit metadata and captured packets.

pub fn metadata(&self) -> &StreamMetadata

Returns the metadata of the recorded stream.

pub fn items(&self) -> &[StreamItem]

Returns the captured packets in their recorded order.

pub fn len(&self) -> usize

Returns the number of captured packets.

pub fn is_empty(&self) -> bool

Reports whether the recording captured no packets.

pub fn replay(&self) -> Stream

Returns a fresh stream that replays the captured packets.

pub fn seek(&self, target: SeekTarget) -> Stream

Replays the recording from the first packet matching target.

pub fn cassette(&self, profile: TransportProfile) -> Result<StreamCassette>

Serializes the recording into a transport cassette for profile.

Trait Implementations

impl Clone for StreamRecording

fn clone(&self) -> StreamRecording

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamRecording

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

Formats the value using the given formatter.

impl Eq for StreamRecording

impl PartialEq for StreamRecording

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