Merge #837

837: More cleanups and enable some more compiler lints r=asomers a=Susurrus

Gonna run this through CI and see what breaks on non-Linux-x64 platforms.

These changes are minor cleanups, but improve our doc story and should help with future submitted PRs.

Author: bors[bot]

CHANGELOG.md

@@ -8,8 +8,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 ### Changed
+- Display and Debug for SysControlAddr now includes all fields.
+  ([#837](https://github.com/nix-rust/nix/pull/837))
 
 ### Fixed
+- Properly exposed 460800 and 921600 baud rates on NetBSD
+  ([#837](https://github.com/nix-rust/nix/pull/837))
 
 ### Removed
 

src/fcntl.rs

@@ -205,6 +205,7 @@ libc_bitflags!(
     }
 );
 
+#[allow(missing_debug_implementations)]
 pub enum FcntlArg<'a> {
     F_DUPFD(RawFd),
     F_DUPFD_CLOEXEC(RawFd),
@@ -230,7 +231,7 @@ pub enum FcntlArg<'a> {
     #[cfg(any(target_os = "linux", target_os = "android"))]
     F_GETPIPE_SZ,
     #[cfg(any(target_os = "linux", target_os = "android"))]
-    F_SETPIPE_SZ(libc::c_int),
+    F_SETPIPE_SZ(c_int),
 
     // TODO: Rest of flags
 }
@@ -267,6 +268,8 @@ pub fn fcntl(fd: RawFd, arg: FcntlArg) -> Result<c_int> {
     Errno::result(res)
 }
 
+#[derive(Clone, Copy)]
+#[allow(missing_debug_implementations)]
 pub enum FlockArg {
     LockShared,
     LockExclusive,
@@ -343,7 +346,7 @@ pub fn vmsplice(fd: RawFd, iov: &[IoVec<&[u8]>], flags: SpliceFFlags) -> Result<
 #[cfg(any(target_os = "linux"))]
 libc_bitflags!(
     /// Mode argument flags for fallocate determining operation performed on a given range.
-    pub struct FallocateFlags: libc::c_int {
+    pub struct FallocateFlags: c_int {
         /// File size is not changed.
         ///
         /// offset + len can be greater than file size.

src/features.rs

@@ -1,3 +1,4 @@
+//! Feature tests for OS functionality
 pub use self::os::*;
 
 #[cfg(any(target_os = "linux", target_os = "android"))]
@@ -82,6 +83,7 @@ mod os {
         }
     }
 
+    /// Check if the OS supports atomic close-on-exec for sockets
     pub fn socket_atomic_cloexec() -> bool {
         kernel_version() >= VERS_2_6_27
     }
@@ -94,6 +96,7 @@ mod os {
 
 #[cfg(any(target_os = "macos", target_os = "freebsd", target_os = "dragonfly", target_os = "ios", target_os = "openbsd", target_os = "netbsd"))]
 mod os {
+    /// Check if the OS supports atomic close-on-exec for sockets
     pub fn socket_atomic_cloexec() -> bool {
         false
     }

src/lib.rs

@@ -10,61 +10,52 @@
 #![allow(dead_code)]
 #![cfg_attr(test, deny(warnings))]
 #![recursion_limit = "500"]
+#![deny(unused)]
+#![deny(unstable_features)]
+#![deny(missing_copy_implementations)]
+#![deny(missing_debug_implementations)]
 
+// External crates
 extern crate bytes;
 #[macro_use]
 extern crate bitflags;
-
 #[macro_use]
 extern crate cfg_if;
 extern crate void;
 
-#[macro_use] mod macros;
-
+// Re-exported external crates
 pub extern crate libc;
 
-use errno::Errno;
+// Private internal modules
+#[macro_use] mod macros;
 
+// Public crates
 pub mod errno;
+#[deny(missing_docs)]
 pub mod features;
 pub mod fcntl;
-
 #[cfg(any(target_os = "linux", target_os = "android"))]
 pub mod mount;
-
 #[cfg(any(target_os = "dragonfly",
           target_os = "freebsd",
           target_os = "fushsia",
           target_os = "linux",
           target_os = "netbsd"))]
 pub mod mqueue;
-
-pub mod pty;
-
-pub mod poll;
-
+#[deny(missing_docs)]
 pub mod net;
-
-#[cfg(any(target_os = "dragonfly",
-          target_os = "freebsd",
-          target_os = "ios",
-          target_os = "linux",
-          target_os = "macos",
-          target_os = "netbsd",
-          target_os = "openbsd"))]
-pub mod ifaddrs;
-
+#[deny(missing_docs)]
+pub mod poll;
+#[deny(missing_docs)]
+pub mod pty;
 #[cfg(any(target_os = "linux", target_os = "android"))]
 pub mod sched;
-
 pub mod sys;
-
 // This can be implemented for other platforms as soon as libc
 // provides bindings for them.
 #[cfg(all(target_os = "linux",
           any(target_arch = "x86", target_arch = "x86_64")))]
 pub mod ucontext;
-
 pub mod unistd;
 
 /*
@@ -73,14 +64,14 @@ pub mod unistd;
  *
  */
 
-use libc::c_char;
-use std::{ptr, result};
+use libc::{c_char, PATH_MAX};
+
+use std::{error, fmt, ptr, result};
 use std::ffi::{CStr, OsStr};
-use std::path::{Path, PathBuf};
 use std::os::unix::ffi::OsStrExt;
-use std::fmt;
-use std::error;
-use libc::PATH_MAX;
+use std::path::{Path, PathBuf};
+
+use errno::Errno;
 
 /// Nix Result Type
 pub type Result<T> = result::Result<T, Error>;
@@ -94,7 +85,7 @@ pub type Result<T> = result::Result<T, Error>;
 /// implementing other common traits.
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub enum Error {
-    Sys(errno::Errno),
+    Sys(Errno),
     InvalidPath,
     /// The operation involved a conversion to Rust's native String type, which failed because the
     /// string did not contain all valid UTF-8.

src/mqueue.rs

@@ -30,6 +30,7 @@ libc_bitflags!{
 
 #[repr(C)]
 #[derive(Clone, Copy)]
+#[allow(missing_debug_implementations)]
 pub struct MqAttr {
     mq_attr: libc::mq_attr,
 }

src/net/mod.rs

@@ -1,3 +1,4 @@
+//! Functionality involving network interfaces
 // To avoid clashing with the keyword "if", we use "if_" as the module name.
 // The original header is called "net/if.h".
 pub mod if_;

src/poll.rs

@@ -1,3 +1,4 @@
+//! Wait for events to trigger on specific file descriptors
 #[cfg(any(target_os = "android", target_os = "dragonfly", target_os = "freebsd", target_os = "linux"))]
 use sys::time::TimeSpec;
 #[cfg(any(target_os = "android", target_os = "dragonfly", target_os = "freebsd", target_os = "linux"))]
@@ -18,6 +19,7 @@ use errno::Errno;
 /// retrieved by calling [`revents()`](#method.revents) on the `PollFd`.
 #[repr(C)]
 #[derive(Clone, Copy)]
+#[allow(missing_debug_implementations)]
 pub struct PollFd {
     pollfd: libc::pollfd,
 }

src/pty.rs

@@ -17,8 +17,12 @@ use errno::Errno;
 ///
 /// This is returned by `openpty`.  Note that this type does *not* implement `Drop`, so the user
 /// must manually close the file descriptors.
+#[derive(Clone, Copy)]
+#[allow(missing_debug_implementations)]
 pub struct OpenptyResult {
+    /// The master port in a virtual pty pair
     pub master: RawFd,
+    /// The slave port in a virtual pty pair
     pub slave: RawFd,
 }
 

src/sched.rs

@@ -9,7 +9,7 @@ use ::unistd::Pid;
 // For some functions taking with a parameter of type CloneFlags,
 // only a subset of these flags have an effect.
 libc_bitflags!{
-    pub struct CloneFlags: libc::c_int {
+    pub struct CloneFlags: c_int {
         CLONE_VM;
         CLONE_FS;
         CLONE_FILES;
@@ -40,6 +40,7 @@ pub type CloneCb<'a> = Box<FnMut() -> isize + 'a>;
 
 #[repr(C)]
 #[derive(Clone, Copy)]
+#[allow(missing_debug_implementations)]
 pub struct CpuSet {
     cpu_set: libc::cpu_set_t,
 }

src/sys/aio.rs

@@ -295,7 +295,7 @@ impl<'a> AioCb<'a> {
             aiocb: a,
             mutable: true,
             in_progress: false,
-            buffer: Buffer::Phantom(PhantomData)
+            buffer: Buffer::Phantom(PhantomData),
         }
     }
 
@@ -379,7 +379,7 @@ impl<'a> AioCb<'a> {
             aiocb: a,
             mutable: false,
             in_progress: false,
-            buffer: Buffer::Bytes(buf2)
+            buffer: Buffer::Bytes(buf2),
         }
     }
 
@@ -464,7 +464,7 @@ impl<'a> AioCb<'a> {
             aiocb: a,
             mutable: true,
             in_progress: false,
-            buffer: Buffer::BytesMut(buf2)
+            buffer: Buffer::BytesMut(buf2),
         }
     }
 
@@ -619,7 +619,7 @@ impl<'a> AioCb<'a> {
             aiocb: a,
             mutable: false,
             in_progress: false,
-            buffer: Buffer::None
+            buffer: Buffer::None,
         }
     }
 

src/sys/epoll.rs

@@ -7,7 +7,7 @@ use std::mem;
 use ::Error;
 
 libc_bitflags!(
-    pub struct EpollFlags: libc::c_int {
+    pub struct EpollFlags: c_int {
         EPOLLIN;
         EPOLLPRI;
         EPOLLOUT;
@@ -42,6 +42,7 @@ libc_bitflags!{
     }
 }
 
+#[allow(missing_debug_implementations)]
 #[derive(Clone, Copy)]
 #[repr(C)]
 pub struct EpollEvent {
@@ -58,7 +59,7 @@ impl EpollEvent {
     }
 
     pub fn events(&self) -> EpollFlags {
-        EpollFlags::from_bits(self.event.events as libc::c_int).unwrap()
+        EpollFlags::from_bits(self.event.events as c_int).unwrap()
     }
 
     pub fn data(&self) -> u64 {

src/sys/event.rs

@@ -14,6 +14,7 @@ use std::mem;
 // Redefine kevent in terms of programmer-friendly enums and bitfields.
 #[derive(Clone, Copy)]
 #[repr(C)]
+#[allow(missing_debug_implementations)]
 pub struct KEvent {
     kevent: libc::kevent,
 }
@@ -24,7 +25,7 @@ pub struct KEvent {
 type type_of_udata = *mut libc::c_void;
 #[cfg(any(target_os = "dragonfly", target_os = "freebsd",
           target_os = "ios", target_os = "macos"))]
-type type_of_data = libc::intptr_t;
+type type_of_data = intptr_t;
 #[cfg(any(target_os = "netbsd"))]
 type type_of_udata = intptr_t;
 #[cfg(any(target_os = "netbsd", target_os = "openbsd"))]

src/sys/mman.rs

@@ -1,13 +1,17 @@
-use {Error, Result, NixPath};
+use {Error, Result};
+#[cfg(not(target_os = "android"))]
+use NixPath;
 use errno::Errno;
+#[cfg(not(target_os = "android"))]
 use fcntl::OFlag;
 use libc::{self, c_int, c_void, size_t, off_t};
+#[cfg(not(target_os = "android"))]
 use sys::stat::Mode;
 use std::os::unix::io::RawFd;
 
 libc_bitflags!{
     /// Desired memory protection of a memory mapping.
-    pub struct ProtFlags: libc::c_int {
+    pub struct ProtFlags: c_int {
         /// Pages cannot be accessed.
         PROT_NONE;
         /// Pages can be read.