Struct UdpSocket 

pub struct UdpSocket { /* private fields */ }

A high-level UDP Socket that allows for writing and reading (de)serializable values

Implementations

impl UdpSocket

pub async fn bind<A: ToSocketAddrs>(addr: A) -> Result<Self, UdpSocketError>

Attempt to create a new UdpSocket by binding it to the provided address

Example

use sockit::UdpSocket;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let socket = UdpSocket::bind("127.0.0.1:0").await?;
  Ok(())
}

pub fn new(socket: UdpSocket) -> Self

Create a new UDP socket from an existing tokio::net::UdpSocket

Example

use sockit::UdpSocket;
use tokio::net::UdpSocket as TokioUdpSocket;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let tokio_socket = TokioUdpSocket::bind("127.0.0.1:0").await?;
  let mut sockit_socket = UdpSocket::new(tokio_socket);
  Ok(())
}

pub async fn write<T: Serialize>( &mut self, value: &T, send_to: SocketAddr, ) -> Result<(), UdpSocketError>

Write a serializable value to the socket

Example

use sockit::UdpSocket;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let mut socket = UdpSocket::bind("127.0.0.1:0").await?;
  socket.write(&"Hello World!", "127.0.0.1:9090".parse()?).await?;
  Ok(())
}

pub async fn read<T: DeserializeOwned>( &mut self, ) -> Result<(T, SocketAddr), UdpSocketError>

Read a deserializable value from a single datagram on the socket

This method returns an error when it isn’t possible to deserialize the value from the datagram. This can happen if the value doesn’t fit into a single datagram.

Example

use sockit::UdpSocket;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let mut socket = UdpSocket::bind("127.0.0.1:0").await?;
  let message = socket.read::<String>().await?;
  Ok(())
}

pub fn local_addr(&self) -> Result<SocketAddr, UdpSocketError>

Get the local address of the socket

Example

use sockit::UdpSocket;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
 let socket = UdpSocket::bind("127.0.0.1:0").await?;
 let addr = socket.local_addr()?;
 Ok(())
}