Struct DecodeJson

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

A block that decodes a JSON format message from a byte stream.

Block Diagram

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

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

Sequence Diagram

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

    BlockA-->>DecodeJSON: Connect
    DecodeJSON-->>BlockB: Connect

    loop DecodeJSON process
        BlockA->>DecodeJSON: Message (Bytes)
        DecodeJSON->>DecodeJSON: Decode from JSON
        DecodeJSON->>BlockB: Message
    end

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

Examples

Using the block in a system

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

Running the block via the CLI

$ protoflow execute DecodeJSON

Fields

input: InputPort<Bytes>

The input message byte stream.

output: OutputPort<Value>

The output JSON value.

Implementations

impl DecodeJson

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

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

Trait Implementations

impl Block for DecodeJson

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 DecodeJson

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 DecodeJson

fn clone(&self) -> DecodeJson

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MaybeLabeled for DecodeJson

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 DecodeJson

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 DecodeJson

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