Struct Reader 

pub struct Reader<T>
where
    T: CpuSample,
{ /* private fields */ }

Circuit Reader

Implementations

impl<T> Reader<T>

where T: CpuSample,

pub fn new() -> Self

Create circuit buffer reader

Trait Implementations

impl<T> BufferReader for Reader<T>

where T: CpuSample,

fn as_any_mut(&mut self) -> &mut dyn Any

Return this reader as Any for runtime downcasting.

fn init(&mut self, block_id: BlockId, port_id: PortId, inbox: BlockInbox)

Initialize the reader with its owning block, port id, and inbox.

fn validate(&self) -> Result<(), Error>

Validate that this reader is connected and ready to run.

async fn notify_finished(&mut self)

Notify upstream writers that this reader is done.

fn finish(&mut self)

Mark this reader because the upstream writer is done.

fn finished(&self) -> bool

Return whether the upstream writer has marked this buffer as done.

fn block_id(&self) -> BlockId

Get the owning block id.

fn port_id(&self) -> PortId

Get the owning port id.

impl<T> CpuBufferReader for Reader<T>

where T: CpuSample,

type Item = T

Item type.

fn slice_with_tags(&mut self) -> (&[Self::Item], &Vec<ItemTag>)

Get readable slice and associated tags.

fn consume(&mut self, n: usize)

Mark n items as consumed.

fn set_min_items(&mut self, _n: usize)

Set minimum number of readable items.

fn set_min_buffer_size_in_items(&mut self, _n: usize)

Set minimum buffer size.

fn max_items(&self) -> usize

Return the maximum number of items that fit in the buffer.

fn slice(&mut self) -> &[Self::Item]

Get readable slice.

impl<T> Default for Reader<T>

where T: CpuSample,

fn default() -> Self

Returns the “default value” for a type.

impl<T> InplaceReader for Reader<T>

where T: CpuSample,

type Item = T

Item type carried by this in-place reader.

type Buffer = Buffer<T>

Buffer chunk type moved through this reader.

fn get_full_buffer(&mut self) -> Option<Self::Buffer>

Get the next full buffer, if one is available.

fn has_more_buffers(&mut self) -> bool

Return whether more full buffers are immediately available.

fn put_empty_buffer(&mut self, buffer: Self::Buffer)

Return an empty buffer to the beginning of the circuit.

fn notify_consumed_buffer(&mut self)

Notify the circuit start that we consumed a buffer.