Struct WriteFile

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

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.

flags: WriteFlags

Implementations

impl WriteFile

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

pub fn with_params( path: InputPort<String>, input: InputPort<Bytes>, flags: Option<WriteFlags>, ) -> Self

pub fn with_system(system: &System, flags: Option<WriteFlags>) -> Self

pub fn with_flags(self, flags: WriteFlags) -> 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 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 WriteFile

fn clone(&self) -> WriteFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MaybeLabeled for WriteFile

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 WriteFile

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 WriteFile

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