Struct ReadDir

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

A block that reads file names from a file system directory.

Block Diagram

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

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

Sequence Diagram

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

    BlockA-->>ReadDir: Connect

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

    loop ReadDir process
        ReadDir->>ReadDir: Read directory entries
        ReadDir->>BlockB: Message (e.g. "/tmp/file.txt")
    end

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

Examples

Using the block in a system

System::build(|s| {
    let path_param = s.const_string("/tmp");
    let dir_reader = s.read_dir();
    let line_encoder = s.encode_lines();
    let stdout = s.write_stdout();
    s.connect(&path_param.output, &dir_reader.path);
    s.connect(&dir_reader.output, &line_encoder.input);
    s.connect(&line_encoder.output, &stdout.input);
});

Running the block via the CLI

$ protoflow execute ReadDir path=/tmp

Fields

path: InputPort<String>

The path to the directory to read.

output: OutputPort<String>

The output message stream.

Implementations

impl ReadDir

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

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

Trait Implementations

impl Block for ReadDir

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 ReadDir

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 ReadDir

fn clone(&self) -> ReadDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MaybeLabeled for ReadDir

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 ReadDir

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 ReadDir

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