From a422e34ca8b8065c8a012b81fcb8bd75dff43184 Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Wed, 13 May 2020 03:06:25 +0200
Subject: [PATCH] Add explanation for `ai_addr` field.

---
 src/unix/linux_like/mod.rs | 2 ++
 src/unix/newlib/mod.rs     | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/src/unix/linux_like/mod.rs b/src/unix/linux_like/mod.rs
index 445f6247..df71ecb2 100644
--- a/src/unix/linux_like/mod.rs
+++ b/src/unix/linux_like/mod.rs
@@ -50,6 +50,8 @@ s! {
         pub sin6_scope_id: u32,
     }
 
+    // The order of the `ai_addr` field in this struct is crucial
+    // for converting between the Rust and C types.
     pub struct addrinfo {
         pub ai_flags: ::c_int,
         pub ai_family: ::c_int,
diff --git a/src/unix/newlib/mod.rs b/src/unix/newlib/mod.rs
index d2a72a86..5f53f613 100644
--- a/src/unix/newlib/mod.rs
+++ b/src/unix/newlib/mod.rs
@@ -24,6 +24,8 @@ pub type time_t = i32;
 pub type useconds_t = u32;
 
 s! {
+    // The order of the `ai_addr` field in this struct is crucial
+    // for converting between the Rust and C types.
     pub struct addrinfo {
         pub ai_flags: ::c_int,
         pub ai_family: ::c_int,
-- 
GitLab