Struct futuresdr::runtime::stream_io::StreamOutput

pub struct StreamOutput { /* private fields */ }

Stream output port

Implementations

impl StreamOutput

pub fn new<T: Any>(name: &str) -> StreamOutput

Create stream output port

pub fn item_size(&self) -> usize

Get size of items, handled by the port

pub fn type_id(&self) -> TypeId

Get TypeId of items, handled by the port

pub fn name(&self) -> &str

Get name of port

pub fn init(&mut self, writer: BufferWriter)

Initialize port, setting the writer

pub fn add_tag(&mut self, index: usize, tag: Tag)

Add ItemTag to sample in port

pub fn add_tag_abs(&mut self, index: usize, tag: Tag)

Add ItemTag using the absolute index

The difference between add_tag and add_tag_abs is only relevant if the work function calls produce multiple times.

pub fn add_reader( &mut self, reader_inbox: Sender<BlockMessage>, reader_port: usize ) -> BufferReader

Connect a downstream reader to the port

pub fn try_as<T: 'static>(&mut self) -> Option<&mut T>

Try to cast buffer writer to specific type

pub fn produce(&mut self, amount: usize)

Produce amount samples

pub fn slice<T>(&mut self) -> &'static mut [T]

Get buffer content as slice

pub fn slice_unchecked<T>(&mut self) -> &'static mut [T]

Get buffer content as slice without checking the type

pub fn produced(&self) -> usize

Items already produced in this call to work

pub async fn notify_finished(&mut self)

Notify downstream readers that we are finished

pub fn finish(&mut self)

Mark port as finshed

pub fn finished(&self) -> bool

Check, if port is marked as finished

Trait Implementations

impl Debug for StreamOutput

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

Formats the value using the given formatter.