Struct InputPort

pub struct InputPort<T>
where
    T: Message,
{ /* private fields */ }

Implementations

impl<T> InputPort<T>

where T: Message,

pub fn new<X>(system: &System<X>) -> InputPort<T>

where X: Transport + Default,

pub fn close(&mut self) -> Result<bool, PortError>

pub fn recv(&self) -> Result<Option<T>, PortError>

pub fn try_recv(&self) -> Result<Option<T>, PortError>

Trait Implementations

impl<T> Clone for InputPort<T>

where T: Clone + Message,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for InputPort<T>

where T: Message,

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

Formats the value using the given formatter.

impl<T> Display for InputPort<T>

where T: Message,

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

Formats the value using the given formatter.

impl<T> From<&InputPort<T>> for PortDescriptor

where T: Message,

fn from(port: &InputPort<T>) -> PortDescriptor

Converts to this type from the input type.

impl<T> MaybeLabeled for InputPort<T>

where T: Message,

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> MaybeNamed for InputPort<T>

where T: Message,

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> MessageReceiver<T> for InputPort<T>

where T: Message,

fn recv(&self) -> Result<Option<T>, PortError>

Receives a message, blocking until one is available.

fn try_recv(&self) -> Result<Option<T>, PortError>

Tries to receive a message, returning immediately.

impl<T> Port for InputPort<T>

where T: Message,

fn id(&self) -> PortID

A unique identifier for this port.

fn state(&self) -> PortState

The current state of this port.

fn close(&mut self) -> Result<bool, PortError>

Closes this port, returning immediately.

fn is_closed(&self) -> bool

Checks whether this port is currently closed.

fn is_open(&self) -> bool

Checks whether this port is currently open.

fn is_connected(&self) -> bool

Checks whether this port is currently connected.