Struct riot_wrappers::socket_embedded_nal::UdpSocket

pub struct UdpSocket<'a> {
    socket: Option<&'a mut sock_udp_t>,
}

Available on riot_module_sock_udp and crate feature with_embedded_nal only.

Fields

socket: Option<&'a mut sock_udp_t>

Implementations

impl<'a> UdpSocket<'a>

fn access(&mut self) -> Result<*mut sock_udp_t, NumericError>

Version of socket() that gives errors compatible with Self::Error

pub fn socket(&mut self) -> Option<*mut sock_udp_t>

Accessor to the inner socket pointer

This can be used by users of the wrapper to alter properties of the socket, as long as that does not interfere with the wrapper’s operation. It is not specified which parts that are; users of this beware that what the wrapper handles can be changed in subsequent versions.

The method is safe on its own because all operations on the *mut are unsafe anyway (including the functions exported in riot-sys). It is not returning a &mut on the inner socket because that would allow swapping it out (which RIOT doesn’t like at all).

fn close(&mut self)

If there is an actual socket in here, close it

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes