Struct Port

pub struct Port { /* private fields */ }

One half of a bidirectional communication channel.

This is a lower-level construct for sending and receiving binary messages. Most code should use a higher-level channel returned by mesh_channel::channel(), which uses this type internally.

Implementations

impl Port

pub fn new_pair() -> (Self, Self)

Creates a new bidirectional channel, returning a pair of ports.

pub fn set_handler<T: HandlePortEvent>(self, handler: T) -> PortWithHandler<T>

Sets the handler for incoming messages.

If there are any queued incoming messages, or if the port has already been closed or failed, then the relevant handler methods will be called directly on this thread.

pub fn bridge(self, other: Self)

Bridges two channels together so that the peer of self is connected directly to the peer of other.

pub fn send(&self, message: Message<'_>)

Sends a message to the peer.

pub fn send_protobuf<T: DefaultEncoding>(&self, value: T)

where T::Encoding: MessageEncode<T, Resource>,

Send a protobuf-encodable message to the peer.

Prefer Port::send if you already have a Message, OwnedMessage, or serialized message, or if the recipient is known to take advantage of the OwnedMessage::try_unwrap optimization.

Otherwise, this method is more efficient since it can avoid an extra allocation to construct a Message.

pub fn is_closed(&self) -> Result<bool, NodeError>

Trait Implementations

impl Debug for Port

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

Formats the value using the given formatter.

impl DefaultEncoding for Port

type Encoding = PortField

The encoding to use for the serialization.

impl Drop for Port

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Default + HandlePortEvent> From<Port> for PortWithHandler<T>

fn from(port: Port) -> Self

Converts to this type from the input type.

impl From<Port> for Resource

fn from(port: Port) -> Self

Converts to this type from the input type.

impl<T: HandlePortEvent> From<PortWithHandler<T>> for Port

fn from(port: PortWithHandler<T>) -> Self

Converts to this type from the input type.

impl TryFrom<Resource> for Port

type Error = ResourceError

The type returned in the event of a conversion error.

fn try_from(value: Resource) -> Result<Self, ResourceError>

Performs the conversion.