Struct Drop

pub struct Drop<T: Message = Any> {
    pub input: InputPort<T>,
}

A block that simply discards all messages it receives.

Block Diagram

block-beta
    columns 4
    Source space:2 Drop
    Source-- "input" -->Drop

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

Sequence Diagram

sequenceDiagram
    autonumber
    participant BlockA as Another block
    participant Drop.input as Drop.input port
    participant Drop as Drop block

    BlockA-->>Drop: Connect

    loop Drop process
        BlockA->>Drop: Message
        Drop->>Drop: Drop message
    end

    BlockA-->>Drop: Disconnect
    Drop-->>Drop.input: Close

Examples

Using the block in a system

System::build(|s| {
    let stdin = s.read_stdin();
    let dropper = s.drop();
    s.connect(&stdin.output, &dropper.input);
});

Running the block via the CLI

$ protoflow execute Drop

Fields

input: InputPort<T>

The input message stream.

Implementations

impl<T: Message> Drop<T>

pub fn new(input: InputPort<T>) -> Self

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

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

Trait Implementations

impl<T: Message> Block for Drop<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 Drop<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 Drop<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Message> MaybeLabeled for Drop<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 Drop<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<T: Message> StdioSystem for Drop<T>

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