Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Notes for implementer not visible on docs.rs #105

Open
JuliDi opened this issue Feb 7, 2024 · 0 comments
Open

Notes for implementer not visible on docs.rs #105

JuliDi opened this issue Feb 7, 2024 · 0 comments

Comments

@JuliDi
Copy link

JuliDi commented Feb 7, 2024

The "notes for implementers" in the async version's udp.rs

//! 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant