Struct std_embedded_nal::Stack

pub struct Stack;

The operating system's network stack, implementing embedded_nal::UdpStack and others.

This is most easily accessed using the static STACK instance.

The stack can be cloned, as it is not a resource that needs any synchronization. This is not made implicit as Copy, though (although there's not technical reason not to). That is to alert users to the difficulties that'd arise when taking ownership of a stack rather than just using it through a shared reference (which is generally possible in embedded_nal).

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Dns for Stack

type Error = Error

The type returned when we have an error

fn gethostbyname(&self, hostname: &str, addr_type: AddrType) -> Result<IpAddr>

Resolve the first ip address of a host, given its hostname and a desired address record type to look for

fn gethostbyaddr(&self, _addr: IpAddr) -> Result<String<U256>>

Resolve the hostname of a host, given its ip address

impl TcpClient for Stack

type TcpSocket = TcpSocket

The type returned when we create a new TCP socket

type Error = Error

The type returned when we have an error

fn socket(&self) -> Result<TcpSocket>

Open a socket for usage as a TCP client.

fn connect(
    &self,
    socket: &mut TcpSocket,
    remote: SocketAddr
) -> Result<(), Self::Error>

Connect to the given remote host and port.

fn is_connected(&self, socket: &TcpSocket) -> Result<bool>

Check if this socket is connected

fn send(
    &self,
    socket: &mut TcpSocket,
    buffer: &[u8]
) -> Result<usize, Self::Error>

Write to the stream.

fn receive(
    &self,
    socket: &mut TcpSocket,
    buffer: &mut [u8]
) -> Result<usize, Self::Error>

Receive data from the stream.

fn close(&self, _: TcpSocket) -> Result<()>

Close an existing TCP socket.

impl UdpClient for Stack

type UdpSocket = UdpSocket

The type returned when we create a new UDP socket

type Error = Error

The type returned when we have an error

fn socket(&self) -> Result<Self::UdpSocket, Self::Error>

Allocate a socket for further use.

fn connect(
    &self,
    socket: &mut Self::UdpSocket,
    remote: SocketAddr
) -> Result<()>

Connect a UDP socket with a peer using a dynamically selected port.

fn send(
    &self,
    socket: &mut Self::UdpSocket,
    buffer: &[u8]
) -> Result<(), Self::Error>

Send a datagram to the remote host.

fn receive(
    &self,
    socket: &mut Self::UdpSocket,
    buffer: &mut [u8]
) -> Result<(usize, SocketAddr), Self::Error>

Read a datagram the remote host has sent to us.

fn close(&self, _: Self::UdpSocket) -> Result<()>

Close an existing UDP socket.