Struct Hash

pub struct Hash {
    pub input: InputPort<Bytes>,
    pub output: OutputPort<Bytes>,
    pub hash: OutputPort<Bytes>,
    pub algorithm: HashAlgorithm,
    /* private fields */
}

Computes the cryptographic hash of a byte stream, while optionally passing it through.

Block Diagram

block-beta
    columns 7
    Source space:2 Hash space:2 Sink
    space:7
    space:7
    space:3 Result space:3
    Source-- "input" -->Hash
    Hash-- "output" -->Sink
    Hash-- "hash" -->Result

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

Sequence Diagram

sequenceDiagram
    autonumber
    participant BlockA as Another block
    participant Hash.input as Hash.input port
    participant Hash as Hash block
    participant Hash.output as Hash.output port
    participant BlockB as Another block
    participant Hash.hash as Hash.hash port
    participant BlockC as Another block

    BlockA-->>Hash: Connect
    Hash-->>BlockB: Connect

    loop Hash process
        BlockA->>Hash: Message (Bytes)
        Hash->>Hash: Update state
        Hash->>BlockB: Message (Bytes)
    end

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

    Hash-->>BlockC: Connect
    Hash->>BlockC: Hash
    Hash-->>Hash.hash: Close
    Hash-->>BlockC: Disconnect

    %% TODO

Examples

Using the block in a system

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

Running the block via the CLI

$ protoflow execute Hash algorithm=blake3

Fields

input: InputPort<Bytes>

The input byte stream.

output: OutputPort<Bytes>

The (optional) output target for the stream being passed through.

hash: OutputPort<Bytes>

The output port for the computed hash.

algorithm: HashAlgorithm

A configuration parameter for which algorithm to use.

Implementations

impl Hash

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

pub fn with_params( input: InputPort<Bytes>, output: OutputPort<Bytes>, hash: OutputPort<Bytes>, algorithm: Option<HashAlgorithm>, ) -> Self

pub fn with_system(system: &System, algorithm: Option<HashAlgorithm>) -> Self

Trait Implementations

impl Block for Hash

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 Hash

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 Hash

fn clone(&self) -> Hash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl MaybeLabeled for Hash

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 Hash

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 Hash

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