Struct Input 

pub struct Input<T> { /* private fields */ }

A typed Input that tries to automatically downcast or deserialize the data received in order to expose &T.

Performance

If the data is received serialized from the upstream node, an allocation is performed to host the deserialized T.

Implementations

impl<T: Send + Sync + 'static> Input<T>

pub async fn recv(&self) -> Result<(Message<T>, Timestamp)>

Returns the first Message<T> that was received, asynchronously, on any of the channels associated with this Input.

If several Message<T> are received at the same time, one is randomly selected.

This method interprets the data to the type associated with this Input<T>.

Performance

As this method interprets the data received additional operations are performed:

• data received serialized is deserialized (an allocation is performed to store an instance of T),
• data received “typed” are checked against the type associated to this Input<T>.

Error

Several errors can occur:

• all the channels are disconnected,
• Zenoh-Flow failed at interpreting the received data as an instance of T.

pub fn try_recv(&self) -> Result<(Message<T>, Timestamp)>

Returns the first Message<T> that was received on any of the channels associated with this Input, or None if all the channels are empty.

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.

Error

Several errors can occur:

• no message was received (i.e. Empty error),
• Zenoh-Flow failed at interpreting the received data as an instance of T.

Note that if some channels are disconnected, for each of such channel an error is logged.

Methods from Deref<Target = 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<LinkMessage>

Returns the first LinkMessage that was received on any of the channels associated with this Input, or an Empty error if there were no messages.

Asynchronous alternative: recv

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

Error

If no message was received, an Empty error is returned. Note that if some channels are disconnected, for each of such channel an error is logged.

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.

Error

An error is returned if all channels are disconnected. For each disconnected channel, an error is separately logged.

Trait Implementations

impl<T: Send + Sync + 'static> Deref for Input<T>

type Target = InputRaw

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.