Struct protoflow_blocks::EncodeHex

pub struct EncodeHex {
    pub input: InputPort<Bytes>,
    pub output: OutputPort<Bytes>,
}

A block that encodes a byte stream into hexadecimal form.

Block Diagram

block-beta
    columns 7
    Source space:2 EncodeHex space:2 Sink
    Source-- "input" -->EncodeHex
    EncodeHex-- "output" -->Sink

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

Sequence Diagram

sequenceDiagram
    autonumber
    participant BlockA as Another block
    participant EncodeHex.input as EncodeHex.input port
    participant EncodeHex as EncodeHex block
    participant EncodeHex.output as EncodeHex.output port
    participant BlockB as Another block

    BlockA-->>EncodeHex: Connect
    EncodeHex-->>BlockB: Connect

    loop EncodeHex process
        BlockA->>EncodeHex: Message (Bytes)
        EncodeHex->>EncodeHex: Encode into hexadecimal
        EncodeHex->>BlockB: Message (Bytes)
    end

    BlockA-->>EncodeHex: Disconnect
    EncodeHex-->>EncodeHex.input: Close
    EncodeHex-->>EncodeHex.output: Close
    EncodeHex-->>BlockB: Disconnect

Examples

Using the block in a system

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

Running the block via the CLI

$ protoflow execute EncodeHex

Fields

input: InputPort<Bytes>

The input byte stream.

output: OutputPort<Bytes>

The output text stream.

Implementations

impl EncodeHex

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

Trait Implementations

impl Block for EncodeHex

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 EncodeHex

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 EncodeHex

fn clone(&self) -> EncodeHex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Definition for EncodeHex

fn is_variation(&self) -> bool

impl Element for EncodeHex

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 EncodeHex

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

impl OccurrenceDefinition for EncodeHex

fn is_individual(&self) -> bool

impl StdioSystem for EncodeHex

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

impl Type for EncodeHex

fn is_abstract(&self) -> bool

fn is_sufficient(&self) -> bool

fn is_conjugated(&self) -> bool

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

impl BlockDefinition for EncodeHex

impl Class for EncodeHex

impl Classifier for EncodeHex

impl ItemDefinition for EncodeHex

impl PartDefinition for EncodeHex

impl Structure for EncodeHex