Trait MessageReceiver

pub trait MessageReceiver<T: Message> {
    // Provided methods
    fn recv(&self) -> PortResult<Option<T>> { ... }
    fn try_recv(&self) -> PortResult<Option<T>> { ... }
}

Provided Methods

fn recv(&self) -> PortResult<Option<T>>

Receives a message, blocking until one is available.

Returns Ok(Some(message)) if a message was received. Returns Ok(None) if the port is closed or disconnected. Returns Err(PortError) if an error occurs.

fn try_recv(&self) -> PortResult<Option<T>>

Tries to receive a message, returning immediately.

Returns Ok(Some(message)) if a message was received. Returns Ok(None) if no message was immediately available. Returns Err(PortError::Disconnected) if the port is disconnected. Returns Err(PortError::Closed) if the port is closed. Returns Err(PortError) if another error occurs.

Implementors

impl<T: Message> MessageReceiver<T> for InputPort<T>

impl<T: Message, const N: usize> MessageReceiver<T> for InputPorts<T, N>