Struct EncodeJson

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

A block that encodes messages into JSON format.

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| {
    // TODO
});

Running the block via the CLI

$ protoflow execute EncodeJSON

Fields

input: InputPort<Value>

The input message stream.

output: OutputPort<Bytes>

The output byte stream.

Implementations

impl EncodeJson

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

pub fn with_system(system: &System) -> Self

Trait Implementations

impl Block for EncodeJson

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 EncodeJson

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 EncodeJson

fn clone(&self) -> EncodeJson

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MaybeLabeled for EncodeJson

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 EncodeJson

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 EncodeJson

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