lib_enums and docs

Signed-off-by: tison <[email protected]>

Author: tisonkun

src/syslog.rs

@@ -1,3 +1,5 @@
+//! Interfaces for controlling system log.
+
 use std::ffi::CString;
 
 #[cfg(target_os = "macos")]
@@ -15,61 +17,91 @@ pub fn syslog(priority: libc::c_int, message: &str) {
     unsafe { libc::syslog(priority, formatter.as_ptr(), message.as_ptr()) }
 }
 
-pub use self::consts::*;
-
-#[cfg(target_os = "macos")]
-mod consts {
-    libc_bitflags! {
-        pub struct LogFlags: libc::c_int {
-            /// Log the process id with each message: useful for identifying instantiations of
-            /// daemons.
-            LOG_PID;
-            /// If syslog() cannot pass the message to syslogd(8) it will attempt to write the
-            /// message to the console ("/dev/console").
-            LOG_CONS;
-            /// Open the connection to syslogd(8) immediately. Normally the open is delayed until
-            /// the first message is logged. Useful for programs that need to manage the order in
-            /// which file descriptors are allocated.
-            LOG_NDELAY;
-            /// Write the message to standard error output as well to the system log.
-            LOG_PERROR;
-        }
+libc_bitflags! {
+    pub struct LogFlags: libc::c_int {
+        /// Log the process id with each message: useful for identifying instantiations of
+        /// daemons.
+        LOG_PID;
+        /// If syslog() cannot pass the message to syslogd(8) it will attempt to write the
+        /// message to the console ("/dev/console").
+        LOG_CONS;
+        /// Open the connection to syslogd(8) immediately. Normally the open is delayed until
+        /// the first message is logged. Useful for programs that need to manage the order in
+        /// which file descriptors are allocated.
+        LOG_NDELAY;
+        /// Write the message to standard error output as well to the system log.
+        LOG_PERROR;
     }
+}
 
-    #[derive(Clone, Copy, Debug, Eq, PartialEq)]
+libc_enum! {
+    /// Severity levels for log messages.
     #[repr(i32)]
     #[non_exhaustive]
     pub enum Severity {
-        LOG_EMERG = libc::LOG_EMERG,
-        LOG_ALERT = libc::LOG_ALERT,
-        LOG_CRIT = libc::LOG_CRIT,
-        LOG_ERR = libc::LOG_ERR,
-        LOG_WARNING = libc::LOG_WARNING,
-        LOG_NOTICE = libc::LOG_NOTICE,
-        LOG_INFO = libc::LOG_INFO,
-        LOG_DEBUG = libc::LOG_DEBUG,
+        /// A panic condition.
+        ///
+        /// This is normally broadcast to all users.
+        LOG_EMERG,
+        /// A condition that should be corrected immediately, such as a corrupted system database.
+        LOG_ALERT,
+        /// Critical conditions, e.g., hard device errors.
+        LOG_CRIT,
+        /// Errors.
+        LOG_ERR,
+        /// Warning messages.
+        LOG_WARNING,
+        /// Conditions that are not error conditions, but should possibly be handled specially.
+        LOG_NOTICE,
+        /// Informational messages.
+        LOG_INFO,
+        /// Messages that contain information normally of use only when debugging a program.
+        LOG_DEBUG,
     }
+}
 
-    #[derive(Clone, Copy, Debug, Eq, PartialEq)]
+libc_enum! {
+    /// Facilities for log messages.
     #[repr(i32)]
     #[non_exhaustive]
     pub enum Facility {
-        LOG_KERN = libc::LOG_KERN,
-        LOG_USER = libc::LOG_USER,
-        LOG_MAIL = libc::LOG_MAIL,
-        LOG_DAEMON = libc::LOG_DAEMON,
-        LOG_AUTH = libc::LOG_AUTH,
-        LOG_SYSLOG = libc::LOG_SYSLOG,
-        LOG_LPR = libc::LOG_LPR,
-        LOG_NEWS = libc::LOG_NEWS,
-        LOG_UUCP = libc::LOG_UUCP,
-        LOG_LOCAL0 = libc::LOG_LOCAL0,
-        LOG_LOCAL1 = libc::LOG_LOCAL1,
-        LOG_LOCAL2 = libc::LOG_LOCAL2,
-        LOG_LOCAL3 = libc::LOG_LOCAL3,
-        LOG_LOCAL4 = libc::LOG_LOCAL4,
-        LOG_LOCAL5 = libc::LOG_LOCAL5,
-        LOG_LOCAL6 = libc::LOG_LOCAL6,
-        LOG_LOCAL7 = libc::LOG_LOCAL7,
+        /// Messages generated by the kernel.
+        ///
+        /// These cannot be generated by any user processes.
+        LOG_KERN,
+        /// Messages generated by random user processes.
+        ///
+        /// This is the default facility identifier if none is specified.
+        LOG_USER,
+        /// The mail system.
+        LOG_MAIL,
+        /// System daemons, such as routed(8), that are not provided for explicitly by other facilities.
+        LOG_DAEMON,
+        /// The authorization system: login(1), su(1), getty(8), etc.
+        LOG_AUTH,
+        /// Messages generated internally by syslogd(8).
+        LOG_SYSLOG,
+        /// The line printer spooling system: cups-lpd(8), cupsd(8), etc.
+        LOG_LPR,
+        /// The network news system.
+        LOG_NEWS,
+        /// The uucp system.
+        LOG_UUCP,
+        /// Reserved for local use.
+        LOG_LOCAL0,
+        /// Reserved for local use.
+        LOG_LOCAL1,
+        /// Reserved for local use.
+        LOG_LOCAL2,
+        /// Reserved for local use.
+        LOG_LOCAL3,
+        /// Reserved for local use.
+        LOG_LOCAL4,
+        /// Reserved for local use.
+        LOG_LOCAL5,
+        /// Reserved for local use.
+        LOG_LOCAL6,
+        /// Reserved for local use.
+        LOG_LOCAL7,
     }
 }