#network

std-embedded-nal

Implementation of the embedded-nal traits for large devices that support the standard library

7 releases

0.1.3 Jul 25, 2022
0.1.2 Nov 1, 2021
0.1.1 Aug 10, 2021
0.0.3 Feb 2, 2021
0.0.1 Sep 2, 2020

#89 in Embedded development

Download history 25/week @ 2022-04-14 16/week @ 2022-04-21 78/week @ 2022-04-28 70/week @ 2022-05-05 137/week @ 2022-05-12 61/week @ 2022-05-19 42/week @ 2022-05-26 64/week @ 2022-06-02 19/week @ 2022-06-09 26/week @ 2022-06-16 22/week @ 2022-06-23 24/week @ 2022-06-30 37/week @ 2022-07-07 11/week @ 2022-07-14 66/week @ 2022-07-21 27/week @ 2022-07-28

148 downloads per month
Used in 5 crates

MIT/Apache

27KB
499 lines

std-embedded-nal

This crate implements the embedded-nal network traits for operating systems that support the standard library's network. .

In that, it is to embedded-nal what linux-embedded-hal is to embedded-hal: A way to use libraries written for the bare-metal embedded world on Linux. (Just that network interfaces are better standardized than hardware access, so it should work on any system).

Usage

As the operating system's network stack is always available, it can be instanciated and used at any time without need for synchronization, roughly like this:

use embedded_nal::nb::block;
use std_embedded_nal::Stack;
use embedded_nal::UdpClient;

let message = [0x50, 0x01, 0x00, 0x00];

let mut stack = Stack::default();
let mut socket = stack.socket()?;
block!(stack.connect(&mut socket, "127.0.0.1:5683".parse()?)?);
block!(stack.send(&mut socket, &message)?);

See the CoAP and HTTP examples for full and working versions.

Performance, non-blocking and async

When using the regular embedded-nal APIs, the client main examples run use nb::block!, which means that there is busy looping until an event arrives (which is bad in clients and terrible in servers).

The general expectation with these APIs based on nb is that users would know when to try again; the UNIX version of the coapclient example illustrates how that would probably be done. (The setup around mio and this library is relatively complex; embedded implementations might get away with less code there.)

On nightly, and gated by the async feature, the asynchronous implementations of the embedded-nal-async crate are available.

Maturity

This crate contains minimal working implementations the traits currently in embedded-nal.

Minimum Supported Rust Version

This crate is build-tested on stable Rust 1.51.0. That is largely following the embedded-nal MSRV. It might compile with older versions but that may change at any time.

Dependencies

~0.6–1.4MB
~26K SLoC