Struct AsyncSocket

pub struct AsyncSocket { /* private fields */ }

A wrapper type around Socket to enable async-await send and receive operations.

This type allows for getting a single future (send or receive) from a socket at a time. This is useful for raw sockets and scalability protocols which cannot leverage Context, and thus need to perform send and receive operations on an owned socket directly.

If you have set up your socket such that it can be used with contexts, it is instead recommended to use AsyncContext, which only needs to borrow the underlying socket. Contexts are more useful for concurrent operations where of futures for each independent operation on a socket.

Implementations

impl AsyncSocket

pub async fn send<M>( &mut self, msg: M, timeout: Option<Duration>, ) -> Result<(), (Message, Error)>

where M: Into<Message>,

Sends a Message to the socket asynchronously.

Errors

• IncorrectState if the internal Aio is already running an operation, or the socket cannot send messages in its current state.
• MessageTooLarge: The message is too large.
• NotSupported: The protocol does not support sending messages.
• OutOfMemory: Insufficient memory available.
• TimedOut: The operation timed out.

pub async fn receive( &mut self, timeout: Option<Duration>, ) -> Result<Message, Error>

Receives a Message from the socket asynchronously.

Errors

• IncorrectState if the internal Aio is already running an operation, or the socket cannot send messages in its current state.
• MessageTooLarge: The message is too large.
• NotSupported: The protocol does not support sending messages.
• OutOfMemory: Insufficient memory available.
• TimedOut: The operation timed out.

pub fn into_inner(self) -> Socket

Grabs the inner Socket.

Trait Implementations

impl Debug for AsyncSocket

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

Formats the value using the given formatter.

impl TryFrom<Socket> for AsyncSocket

type Error = Error

The type returned in the event of a conversion error.

fn try_from(socket: Socket) -> Result<Self, Self::Error>

Performs the conversion.