Struct protoflow_blocks::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

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 name(&self) -> Option<String>

The machine-readable name of this block.

fn label(&self) -> Option<String>

A human-readable label for this block.

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

fn is_variation(&self) -> bool

impl Element for ReadFile

fn id(&self) -> Option<&str>

The unique element ID, if any.

fn alias_ids(&self) -> Vec<&str>

Various alternative identifiers for this Element.

fn name(&self) -> Option<&str>

The name of the element.

fn short_name(&self) -> Option<&str>

The short name of the element, if any.

fn is_library_element(&self) -> bool

Whether this Element is contained in the ownership tree of a library model.

fn owner(&self) -> Option<&dyn Element>

The owner of this Element, if any.

fn owning_namespace(&self) -> Option<&dyn Namespace>

The Namespace that owns this Element, if any.

fn owning_relationship(&self) -> Option<&dyn Relationship>

The Relationship for which this Element is an owned_related_element, if any.

fn qualified_name(&self) -> Option<QualifiedName>

impl Namespace for ReadFile

fn names_of(&self, _element: &dyn Element) -> Vec<String>

impl OccurrenceDefinition for ReadFile

fn is_individual(&self) -> bool

impl StdioSystem for ReadFile

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

impl Type for ReadFile

fn is_abstract(&self) -> bool

fn is_sufficient(&self) -> bool

fn is_conjugated(&self) -> bool

fn specializes(&self, _supertype: &Self) -> bool

impl BlockDefinition for ReadFile

impl Class for ReadFile

impl Classifier for ReadFile

impl ItemDefinition for ReadFile

impl PartDefinition for ReadFile

impl Structure for ReadFile