-
Notifications
You must be signed in to change notification settings - Fork 25
Open
Description
The "notes for implementers" in the async version's udp.rs
embedded-nal/embedded-nal-async/src/stack/udp.rs
Lines 1 to 15 in 2ad0b03
//! Traits for using UDP on embedded devices | |
//! | |
//! ## Notes for implementers | |
//! | |
//! * At several places, the APIs expect to provide a local address. Backends that can not obtain | |
//! it, such as some AT-command based stacks, <!-- should question whether they may really call | |
//! themselves UDP and --> may pretend to have performed some form of network address | |
//! translation, and present invalid addresses as the local address. | |
//! | |
//! * Implementing [`UdpStack::UniquelyBound`] and [`UdpStack::MultiplyBound`] unconnected sockets | |
//! separately allows discarding the local addresses in the bound case. With LTO enabled, all the | |
//! overhead compared with a third trait variant between [ConnectedUdp] and [UnconnectedUdp] (in | |
//! which the local address is static but the remote address is flexible) should optimized out. | |
//! Implementing `UniquelyBound` and `MultiplyBound` with the same type is expected to be a | |
//! common choice. |
do not appear on docs.rs as from what I see.
If you let me know where it is supposed to appear, I could try fixing it and make a PR. Supposedly it should appear at the top of each trait's page, i.e., be moved below this line:
/// address at connect time. |
Metadata
Metadata
Assignees
Labels
No labels