Struct protoflow_blocks::WriteFile

pub struct WriteFile {
    pub path: InputPort<String>,
    pub input: InputPort<Bytes>,
}

A block that writes or appends bytes to the contents of a file.

Block Diagram

block-beta
    columns 4
    space:3 Config
    space:4
    space:4
    Source space:2 WriteFile
    Config-- "path" -->WriteFile
    Source-- "input" -->WriteFile

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

Sequence Diagram

sequenceDiagram
    autonumber
    participant BlockA as Another block
    participant WriteFile.path as WriteFile.path port
    participant WriteFile as WriteFile block
    participant WriteFile.input as WriteFile.input port
    participant BlockB as Another block

    BlockA-->>WriteFile: Connect

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

    BlockB-->>WriteFile: Connect

    loop WriteFile process
        BlockB->>WriteFile: Message (Bytes)
        WriteFile->>WriteFile: Write bytes to the file
    end

    BlockB-->>WriteFile: Disconnect
    WriteFile-->>WriteFile.input: Close

Examples

Using the block in a system

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

Running the block via the CLI

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

Fields

path: InputPort<String>

The path to the file to write to.

input: InputPort<Bytes>

The input message stream.

Implementations

impl WriteFile

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

Trait Implementations

impl Block for WriteFile

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 WriteFile

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 WriteFile

fn clone(&self) -> WriteFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Definition for WriteFile

fn is_variation(&self) -> bool

impl Element for WriteFile

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 WriteFile

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

impl OccurrenceDefinition for WriteFile

fn is_individual(&self) -> bool

impl StdioSystem for WriteFile

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

impl Type for WriteFile

fn is_abstract(&self) -> bool

fn is_sufficient(&self) -> bool

fn is_conjugated(&self) -> bool

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

impl BlockDefinition for WriteFile

impl Class for WriteFile

impl Classifier for WriteFile

impl ItemDefinition for WriteFile

impl PartDefinition for WriteFile

impl Structure for WriteFile