Struct WriteStream 

pub struct WriteStream<T> { /* private fields */ }

The write part of a stream.

Implementations

impl<T> WriteStream<T>

pub fn new() -> (WriteStream<T>, ReadStream<T>)

Create new stream pair.

impl<T: Copy> WriteStream<T>

pub fn free(&self) -> usize

Return free space in the stream, in samples.

pub fn write_buf(&self) -> Result<BufferWriter<T>>

Return a BufferWriter for writing to the stream.

Ideally having a BufferWriter active on a stream should be prevented statically, but I’ve not come up with a way to do that.

Having write_buf hold on to a mutable reference won’t work, because streams are owned by blocks, and blocks need to be able to call their own mutable methods.

BufferWriters do get an Arc to the circ buffer, though, so there should never be more than four references:

• The source block.
• The destination block.
• The source BufferWriter.
• The destination BufferReader.

So this function needs to be called when the refcount is 3 or lower.

Having more than four references is a definite coding bug, and hopefully will be caught by MTGraph testing during development.

The above also goes for ReadStream::read_buf.

pub fn wait_for_write(&self, need: usize) -> bool

Trait Implementations

impl<T: Debug> Debug for WriteStream<T>

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

Formats the value using the given formatter.

impl<T> StreamReadSide for WriteStream<T>

type ReadSide = ReadStream<T>

impl<T: Copy + Send + Sync> StreamWait for WriteStream<T>

fn id(&self) -> usize

ID shared between read and write side.

fn wait(&self, need: usize) -> bool

Wait for “a while” or until need samples are available/space available.

fn closed(&self) -> bool

Return true if the other end of this stream is disconnected.