Struct Random

pub struct Random<T: Message = u64> {
    pub output: OutputPort<T>,
    pub seed: Option<u64>,
}

A block for generating and sending a random value.

Block Diagram

block-beta
    columns 4
    Random space:2 Sink
    Random-- "output" -->Sink

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

Sequence Diagram

sequenceDiagram
    autonumber
    participant Random as Random block
    participant Random.output as Random.output port
    participant BlockA as Another block

    Random-->>BlockA: Connect

    Random->>BlockA: Message

    Random-->>Random.output: Close
    Random-->>BlockA: Disconnect

Examples

Using the block in a system

System::build(|s| {
    let random_generator = s.random::<u64>();
    let number_encoder = s.encode_lines();
    let stdout = s.write_stdout();
    s.connect(&random_generator.output, &number_encoder.input);
    s.connect(&number_encoder.output, &stdout.input);
});

Running the block via the CLI

$ protoflow execute Random

$ protoflow execute Random seed=42

Fields

output: OutputPort<T>

The port to send the value on.

seed: Option<u64>

A parameter for the random seed to use.

Implementations

impl<T: Message> Random<T>

pub fn new(output: OutputPort<T>) -> Self

pub fn with_params(output: OutputPort<T>, seed: Option<u64>) -> Self

impl<T: Message + 'static> Random<T>

pub fn with_system(system: &System, seed: Option<u64>) -> Self

Trait Implementations

impl<T: Message + Default> Block for Random<T>

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<T: Message> BlockDescriptor for Random<T>

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<T: Clone + Message> Clone for Random<T>

fn clone(&self) -> Random<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Message> MaybeLabeled for Random<T>

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<T: Message> MaybeNamed for Random<T>

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 Random<u64>

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