Struct protoflow_blocks::Drop

pub struct Drop<T: Message> {
    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

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 name(&self) -> Option<String>

The machine-readable name of this block.

fn label(&self) -> Option<String>

A human-readable label for this block.

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> Definition for Drop<T>

fn is_variation(&self) -> bool

impl<T: Message> Element for Drop<T>

fn id(&self) -> Option<&str>

The unique element ID, if any.

fn alias_ids(&self) -> Vec<&str>

Various alternative identifiers for this Element.

fn name(&self) -> Option<&str>

The name of the element.

fn short_name(&self) -> Option<&str>

The short name of the element, if any.

fn is_library_element(&self) -> bool

Whether this Element is contained in the ownership tree of a library model.

fn owner(&self) -> Option<&dyn Element>

The owner of this Element, if any.

fn owning_namespace(&self) -> Option<&dyn Namespace>

The Namespace that owns this Element, if any.

fn owning_relationship(&self) -> Option<&dyn Relationship>

The Relationship for which this Element is an owned_related_element, if any.

fn qualified_name(&self) -> Option<QualifiedName>

impl<T: Message> Namespace for Drop<T>

fn names_of(&self, _element: &dyn Element) -> Vec<String>

impl<T: Message> OccurrenceDefinition for Drop<T>

fn is_individual(&self) -> bool

impl<T: Message> StdioSystem for Drop<T>

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

impl<T: Message> Type for Drop<T>

fn is_abstract(&self) -> bool

fn is_sufficient(&self) -> bool

fn is_conjugated(&self) -> bool

fn specializes(&self, _supertype: &Self) -> bool

impl<T: Message> BlockDefinition for Drop<T>

impl<T: Message> Class for Drop<T>

impl<T: Message> Classifier for Drop<T>

impl<T: Message> ItemDefinition for Drop<T>

impl<T: Message> PartDefinition for Drop<T>

impl<T: Message> Structure for Drop<T>