Skip to content

Commit 703089e

Browse files
committed
Add documentation for Timestamping return type
1 parent cabe208 commit 703089e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/sys/socket/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -563,6 +563,8 @@ pub enum ControlMessageOwned {
563563
#[cfg(all(target_os = "linux"))]
564564
ScmTimestampns(TimeSpec),
565565
/// Configurable nanoseconds resolution timestamps
566+
/// Three `TimeSpec`s are returned in the control message. At least one field is non-zero at
567+
/// any time. Most timestamps are passed in ts[0]. Hardware timestamps are passed in ts[2].
566568
///
567569
/// [Further reading](https://www.kernel.org/doc/html/latest/networking/timestamping.html)
568570
#[cfg(all(target_os = "linux"))]

0 commit comments

Comments
 (0)