Skip to content

Commit ad5488e

Browse files
committed
(Hopefully) improve a comment about getifaddrs.
1 parent ea4ba47 commit ad5488e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/ifaddrs.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,9 @@ impl Iterator for InterfaceAddressIterator {
110110
///
111111
/// Note that the underlying implementation differs between OSes. Only the
112112
/// most common address families are supported by the nix crate (due to
113-
/// lack of time and complexity of testing). For any entry not supported,
113+
/// lack of time and complexity of testing). The address familiy is encoded
114+
/// in the specific variant of `SockAddr` returned for the fields `address`,
115+
/// `netmask`, `broadcast`, and `destination`. For any entry not supported,
114116
/// the returned list will contain a `None` entry.
115117
///
116118
/// # Example

0 commit comments

Comments
 (0)