Struct zenoh_flow_nodes::prelude::InputRaw

pub struct InputRaw { /* private fields */ }

An InputRaw receives “raw” LinkMessage.

As opposed to a typed Input<T>, an InputRaw will not perform any operation on the data it receives. This behaviour is useful when access to the underlying data is either irrelevant (e.g. for rate-limiting purposes) or when Zenoh-Flow should not attempt to interpret the contained Payload (e.g. for bindings).

Implementations

impl InputRaw

pub fn port_id(&self) -> &PortId

pub fn channels_count(&self) -> usize

Returns the number of channels associated with this Input.

pub fn try_recv(&self) -> Result<Option<LinkMessage>>

Returns the first queued LinkMessage or None if there is no queued message.

Asynchronous alternative: recv

This method is a synchronous fail-fast alternative to it’s asynchronous counterpart: recv. Although synchronous, this method will not block the thread on which it is executed.

Errors

An error is returned if the associated channel is disconnected.

pub async fn recv(&self) -> Result<LinkMessage>

Returns the first LinkMessage that was received, asynchronously, on any of the channels associated with this Input.

If several LinkMessage are received at the same time, one is randomly selected.

Errors

An error is returned if a channel was disconnected.

Trait Implementations

impl Clone for InputRaw

fn clone(&self) -> InputRaw

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputRaw

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.