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.

Sign up for GitHub

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

docs: Improve UdpMetadata doc comments. #1014

Merged
merged 1 commit into from
Nov 26, 2024
Merged

docs: Improve UdpMetadata doc comments. #1014

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/socket/udp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ use crate::wire::{IpAddress, IpEndpoint, IpListenEndpoint, IpProtocol, IpRepr, U
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct UdpMetadata {
/// The IP endpoint from which an incoming datagram was received, or to which an outgoing
/// datagram will be sent.
pub endpoint: IpEndpoint,
/// The IP address to which an incoming datagram was sent, or to which an outgoing datagram
/// The IP address to which an incoming datagram was sent, or from which an outgoing datagram
/// will be sent. Incoming datagrams always have this set. On outgoing datagrams, if it is not
/// set, and the socket is not bound to a single address anyway, a suitable address will be
/// determined using the algorithms of RFC 6724 (candidate source address selection) or some
Expand Down