Struct Buffer

pub struct Buffer<T: Message = Any> {
    pub input: InputPort<T>,
    /* private fields */
}

A block that simply stores all messages it receives.

Block Diagram

block-beta
    columns 4
    Source space:2 Buffer
    Source-- "input" -->Buffer

    classDef block height:48px,padding:8px;
    classDef hidden visibility:none;
    class Buffer block
    class Source hidden

Sequence Diagram

sequenceDiagram
    autonumber
    participant BlockA as Another block
    participant Buffer.input as Buffer.input port
    participant Buffer as Buffer block

    BlockA-->>Buffer: Connect

    loop Buffer process
        BlockA->>Buffer: Message
        Buffer->>Buffer: Store message
    end

    BlockA-->>Buffer: Disconnect
    Buffer-->>Buffer.input: Close

Examples

Using the block in a system

System::build(|s| {
    let stdin = s.read_stdin();
    let buffer = s.buffer();
    s.connect(&stdin.output, &buffer.input);
});

Running the block via the CLI

$ protoflow execute Buffer

Fields

input: InputPort<T>

The input message stream.

Implementations

impl<T: Message> Buffer<T>

pub fn new(input: InputPort<T>) -> Self

pub fn messages(&self) -> &VecDeque<T>

impl<T: Message + 'static> Buffer<T>

pub fn with_system(system: &System) -> Self

Trait Implementations

impl<T: Message> Block for Buffer<T>

fn execute(&mut self, _runtime: &dyn BlockRuntime) -> BlockResult

Executes this block’s computation.

fn prepare(&mut self, _runtime: &dyn BlockRuntime) -> Result<(), BlockError>

Prepares this block for execution.

impl<T: Message> BlockDescriptor for Buffer<T>

fn inputs(&self) -> Vec<PortDescriptor>

A description of this block’s input ports.

fn outputs(&self) -> Vec<PortDescriptor>

A description of this block’s output ports.

fn parameters(&self) -> Vec<ParameterDescriptor>

A description of this block’s parameters.

fn ports(&self) -> Vec<PortDescriptor>

A description of this block’s I/O ports.

impl<T: Clone + Message> Clone for Buffer<T>

fn clone(&self) -> Buffer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Message> MaybeLabeled for Buffer<T>

fn label(&self) -> Option<Cow<'_, str>>

Returns the human-readable label, if any, of the object.

fn is_labeled(&self) -> bool

Checks whether the object has a human-readable label.

impl<T: Message> MaybeNamed for Buffer<T>

fn name(&self) -> Option<Cow<'_, str>>

Returns the name, if any, of the object.

fn is_named(&self) -> bool

Checks whether the object has a name.

impl<T: Message> StdioSystem for Buffer<T>

fn build_system(config: StdioConfig) -> Result<System, StdioError>