Struct ReadFile

pub struct ReadFile {
    pub path: InputPort<String>,
    pub output: OutputPort<Bytes>,
}

A block that reads bytes from the contents of a file.

Block Diagram

block-beta
    columns 4
    Config space:3
    space:4
    space:4
    ReadFile space:2 Sink
    Config-- "path" -->ReadFile
    ReadFile-- "output" -->Sink

    classDef block height:48px,padding:8px;
    classDef hidden visibility:none;
    class ReadFile block
    class Config hidden
    class Sink hidden

Sequence Diagram

sequenceDiagram
    autonumber
    participant BlockA as Another block
    participant ReadFile.path as ReadFile.path port
    participant ReadFile as ReadFile block
    participant ReadFile.output as ReadFile.output port
    participant BlockB as Another block

    BlockA-->>ReadFile: Connect

    BlockA->>ReadFile: Message (e.g. "/tmp/file.txt")
    ReadFile-->>ReadFile.path: Close
    ReadFile-->>BlockA: Disconnect
    ReadFile-->>BlockB: Connect

    loop ReadFile process
        ReadFile->>ReadFile: Read bytes from the file
        ReadFile->>BlockB: Message (Bytes)
    end

    ReadFile-->>ReadFile.output: Close
    ReadFile-->>BlockB: Disconnect

Examples

Using the block in a system

System::build(|s| {
    // TODO
});

Running the block via the CLI

$ protoflow execute ReadFile path=/tmp/file.txt

Fields

path: InputPort<String>

The path to the file to read from.

output: OutputPort<Bytes>

The output message stream.

Implementations

impl ReadFile

pub fn new(path: InputPort<String>, output: OutputPort<Bytes>) -> Self

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

Trait Implementations

impl Block for ReadFile

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 BlockDescriptor for ReadFile

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 Clone for ReadFile

fn clone(&self) -> ReadFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MaybeLabeled for ReadFile

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 MaybeNamed for ReadFile

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 StdioSystem for ReadFile

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