Struct std_embedded_nal::Stack

pub struct Stack;

The operating system’s network stack, implementing embedded_nal::UdpFullStack and others.

The user may instantiate a stack using the Stack::default() function.

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 copying around a stack rather than using it through some mechanism of synchronization (which is generally required with embedded_nal since version 0.3).

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Stack

fn default() -> Stack

Returns the “default value” for a type.

impl Dns for Stack

type Error = Error

The type returned when we have an error

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

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

fn get_host_by_address(
    &mut self,
    _addr: IpAddr
) -> Result<String<256>, Error<Error>>

Resolve the hostname of a host, given its ip address

impl TcpClientStack 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(&mut self) -> Result<TcpSocket>

Open a socket for usage as a TCP client.

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

Connect to the given remote host and port.

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

Check if this socket is connected

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

Write to the stream.

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

Receive data from the stream.

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

Close an existing TCP socket.

impl TcpFullStack for Stack

fn bind(&mut self, socket: &mut TcpSocket, port: u16) -> Result<(), Error>

Create a new TCP socket and bind it to the specified local port.

fn listen(&mut self, _: &mut TcpSocket) -> Result<(), Error>

Begin listening for connection requests on a previously-bound socket.

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

Accept an active connection request on a listening socket.

impl UdpClientStack 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(&mut self) -> Result<Self::UdpSocket, Self::Error>

Allocate a socket for further use.

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

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

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

Send a datagram to the remote host.

fn receive(
    &mut 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(&mut self, _: Self::UdpSocket) -> Result<()>

Close an existing UDP socket.

impl UdpFullStack for Stack

fn bind(&mut self, socket: &mut UdpSocket, port: u16) -> Result<(), Error>

Bind a UDP socket with a specified port

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

Send a packet to a remote host/port.