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

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.

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

fn is_variation(&self) -> bool

impl Element for ReadDir

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 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 Namespace for ReadDir

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

impl OccurrenceDefinition for ReadDir

fn is_individual(&self) -> bool

impl StdioSystem for ReadDir

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

impl Type for ReadDir

fn is_abstract(&self) -> bool

fn is_sufficient(&self) -> bool

fn is_conjugated(&self) -> bool

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

impl BlockDefinition for ReadDir

impl Class for ReadDir

impl Classifier for ReadDir

impl ItemDefinition for ReadDir

impl PartDefinition for ReadDir

impl Structure for ReadDir