Struct protoflow_blocks::WriteStdout

pub struct WriteStdout {
    pub input: InputPort<Bytes>,
}

A block that writes bytes to standard output (aka stdout).

Block Diagram

block-beta
    columns 4
    Source space:2 WriteStdout
    Source-- "input" -->WriteStdout

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

Sequence Diagram

sequenceDiagram
    autonumber
    participant BlockA as Another block
    participant WriteStdout.input as WriteStdout.input port
    participant WriteStdout as WriteStdout block

    BlockA-->>WriteStdout: Connect

    loop WriteStdout process
        BlockA->>WriteStdout: Message (Bytes)
        WriteStdout->>WriteStdout: Write bytes to standard output
    end

    BlockA-->>WriteStdout: Disconnect
    WriteStdout-->>WriteStdout.input: Close

Examples

Using the block in a system

System::build(|s| {
    let stdin = s.read_stdin();
    let stdout = s.write_stdout();
    s.connect(&stdin.output, &stdout.input);
});

Running the block via the CLI

$ protoflow execute WriteStdout < input.txt > output.txt

Fields

input: InputPort<Bytes>

The input message stream.

Implementations

impl WriteStdout

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

Trait Implementations

impl Block for WriteStdout

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 WriteStdout

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 WriteStdout

fn clone(&self) -> WriteStdout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Definition for WriteStdout

fn is_variation(&self) -> bool

impl Element for WriteStdout

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 WriteStdout

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 WriteStdout

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 WriteStdout

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

impl OccurrenceDefinition for WriteStdout

fn is_individual(&self) -> bool

impl StdioSystem for WriteStdout

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

impl Type for WriteStdout

fn is_abstract(&self) -> bool

fn is_sufficient(&self) -> bool

fn is_conjugated(&self) -> bool

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

impl BlockDefinition for WriteStdout

impl Class for WriteStdout

impl Classifier for WriteStdout

impl ItemDefinition for WriteStdout

impl PartDefinition for WriteStdout

impl Structure for WriteStdout