Struct UdpSocket

#[repr(C)]
pub struct UdpSocket<S: SocketState = Unbound, B: SocketBuffer = Vec<u8>> { /* private fields */ }

A UDP socket

Notes

• Remote host (Self::remote) is set when the socket is bound calling bind()
• In addition to supporting the creation (with new) and manual management of the socket, this struct implements EasySocket trait, which allows for an easier management of the socket, providing the open method as an alternative to new. This method return a UdpSocket already connected, and ready to send/receive data (using the write and read methods).
• The socket is closed when the struct is dropped. Closing via drop is best-effort.

Implementations

impl UdpSocket

pub fn new() -> Result<UdpSocket<Unbound>, SocketError>

Create a socket

Notes

• Creating a new socket is not sufficient to start sending/receiving data. You must call Self::open() (if you’re using it in EasySocket mode), or Self::bind() and/or Self::connect().

Errors

• SocketError::Errno if the socket could not be created

impl<S: SocketState> UdpSocket<S>

pub fn fd(&self) -> i32

Get the file descriptor of the socket

pub fn remote(&self) -> Option<SocketAddr>

Get the remote address of the socket

pub fn send_flags(&self) -> SocketSendFlags

Flags used when sending data

pub fn set_send_flags(&mut self, send_flags: SocketSendFlags)

Set the flags used when sending data

pub fn recv_flags(&self) -> SocketRecvFlags

Flags used when receiving data

pub fn set_recv_flags(&mut self, recv_flags: SocketRecvFlags)

Set the flags used when receiving data

impl UdpSocket<Unbound>

pub fn bind( self, addr: Option<SocketAddr>, ) -> Result<UdpSocket<Bound>, SocketError>

Bind the socket

Parameters

• addr: The address to bind to, if None binds to 0.0.0.0:0

Returns

• Ok(UdpSocket<Bound>) if the binding was successful
• Err(SocketError) if the binding was unsuccessful.

Errors

• SocketError::Errno if the binding was unsuccessful

impl UdpSocket<Bound>

pub fn connect( self, addr: SocketAddr, ) -> Result<UdpSocket<Connected>, SocketError>

Connect to a remote host

Notes

The socket must be in state [UdpSocketState::Bound] to connect to a remote host. To bind the socket use bind().

Returns

• Ok(UdpSocket<Connected>) if the connection was successful
• Err(SocketError) if the connection was unsuccessful

Errors

• Any SocketError if the connection was unsuccessful

pub fn _read_from( self, buf: &mut [u8], ) -> Result<(usize, UdpSocket<Connected>), SocketError>

Read from a bound socket

Parameters

• buf: The buffer where to store the received data

Returns

• Ok((usize, UdpSocket<Connected>)) if the write was successful. The number of bytes read
• Err(SocketError) if the read was unsuccessful.

Errors

• Any SocketError if the read was unsuccessful

pub fn _write_to( self, buf: &[u8], len: usize, to: SocketAddr, ) -> Result<(usize, UdpSocket<Connected>), SocketError>

Write to a bound socket

Parameters

• buf: The buffer containing the data to send

Returns

• Ok((usize, UdpSocket<Connected>)) if the send was successful. The number of bytes sent
• Err(SocketError) if the send was unsuccessful.

Errors

• Any SocketError if the send was unsuccessful

impl UdpSocket<Connected>

pub fn internal_read(&mut self, buf: &mut [u8]) -> Result<usize, SocketError>

Read from a socket

Parameters

• buf: The buffer where to store the received data

Returns

• Ok(usize) if the read was successful. The number of bytes read
• Err(SocketError) if the read was unsuccessful.

Errors

• Any SocketError if the read was unsuccessful

pub fn internal_write(&mut self, buf: &[u8]) -> Result<usize, SocketError>

Write to a socket

Returns

• Ok(usize) if the send was successful. The number of bytes sent
• Err(SocketError) if the send was unsuccessful.

Errors

• Any SocketError if the send was unsuccessful

pub fn internal_flush(&mut self) -> Result<(), SocketError>

Flush the send buffer

Errors

• Any SocketError if the flush was unsuccessful.

Trait Implementations

impl<S: Clone + SocketState, B: Clone + SocketBuffer> Clone for UdpSocket<S, B>

fn clone(&self) -> UdpSocket<S, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: SocketState> ErrorType for UdpSocket<S>

type Error = SocketError

Error type of all the IO operations on this type.

impl Open<'_, '_> for UdpSocket<Unbound>

fn open(self, options: &Self::Options<'_>) -> Result<Self::Return, Self::Error>

Open the socket

Parameters

• options: The options to use when opening the socket.

Returns

• Ok(UdpSocket<Connected>) if the socket was opened successfully
• Err(SocketError) if the socket failed to open.

Examples

let socket = UdpSocket::new()?;
let socket = socket.open(&SocketOptions::default())?;

type Return = UdpSocket<Connected>

impl<S: SocketState> OptionType for UdpSocket<S>

type Options<'a> = SocketOptions

impl Read for UdpSocket<Connected>

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read from the socket

Parameters

• buf: The buffer where the read data will be stored

Returns

• Ok(usize) if the read was successful. The number of bytes read
• Err(SocketError) if the read was unsuccessful.

fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf.

impl Write for UdpSocket<Connected>

fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write to the socket

Parameters

• buf: The data to write

Returns

• Ok(usize) if the write was successful. The number of bytes written
• Err(SocketError) if the write was unsuccessful.

fn flush(&mut self) -> Result<(), Self::Error>

Flush the socket

Errors

• Any SocketError if the flush was unsuccessful.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer.

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered.

impl EasySocket for UdpSocket<Connected>