Expose more fields and types for callers that want more control. (#17)

This PR makes access to fields of the logger and process config public and
provides a limited set of constructor functions.

This will allow using those types with your own configuration machinery.

Author: ximon18

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macOS-latest]
-        rust: [1.81.0, stable, beta, nightly]
+        rust: [1.82.0, stable, beta, nightly]
     steps:
     - name: Checkout repository
       uses: actions/checkout@v1

Cargo.toml

@@ -2,7 +2,7 @@
 name = "daemonbase"
 version = "0.1.4"
 edition = "2021"
-rust-version = "1.81"
+rust-version = "1.82"
 authors = ["NLnet Labs <rust-team@nlnetlabs.nl>"]
 description = "A library for providing the foundation for daemon processes."
 documentation = "https://docs.rs/daemonbase/"

src/logging.rs

@@ -7,12 +7,17 @@ use std::path::PathBuf;
 use std::str::FromStr;
 use std::sync::{Mutex, MutexGuard, OnceLock};
 use clap::ArgAction;
-use log::LevelFilter;
 use log::error;
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 use crate::config::{ConfigFile, ConfigPath};
 use crate::error::{ExitError, Failed};
 
+// Export LevelFilter for clients that don't use log, e.g. if they use tracing
+// instead.
+pub use log::LevelFilter;
+
+#[cfg(unix)]
+pub use syslog::Facility;
 
 //------------ Logger --------------------------------------------------------
 
@@ -27,6 +32,13 @@ pub struct Logger {
 }
 
 impl Logger {
+    pub fn new(level: LevelFilter, target: Target) -> Self {
+        Self {
+            level,
+            target,
+        }
+    }
+
     /// Initialize logging.
     ///
     /// Initializes the logging system so it can be used before having
@@ -381,11 +393,25 @@ pub struct Args {
 }
 
 impl Args {
-    pub fn to_config(&self) -> Config {
-        Config::from_args(self)
+    #[cfg(unix)]
+    pub fn is_syslog(&self) -> bool {
+        self.syslog
+    }
+
+    pub fn is_stderr(&self) -> bool {
+        self.stderr
     }
 
-    fn opt_level(&self) -> Option<LevelFilter> {
+    pub fn log_file(&self) -> Option<&LogPath> {
+        self.logfile.as_ref()
+    }
+
+    #[cfg(unix)]
+    pub fn syslog_facility(&self) -> Option<&unix::FacilityArg> {
+        self.syslog_facility.as_ref()
+    }
+
+    pub fn opt_level(&self) -> Option<LevelFilter> {
         if self.verbose > 1 {
             Some(LevelFilter::Debug)
         }
@@ -402,6 +428,10 @@ impl Args {
             None
         }
     }
+
+    pub fn to_config(&self) -> Config {
+        Config::from_args(self)
+    }
 }
 
 

src/process.rs

@@ -1,7 +1,7 @@
 //! Process management.
 
 #[cfg(unix)]
-pub use self::unix::{Args, Config, Process};
+pub use self::unix::{Args, Config, Process, UserId, GroupId};
 
 #[cfg(target_os = "linux")]
 pub use self::linux::EnvSockets;
@@ -491,10 +491,20 @@ mod unix {
             Ok(self)
         }
 
+        pub fn with_user_id(mut self, user_id: UserId) -> Self {
+            self.user = Some(user_id);
+            self
+        }
+
         pub fn with_group(mut self, v: &str) -> Result<Self, String> {
             self.group = Some(GroupId::from_str(v)?);
             Ok(self)
         }
+
+        pub fn with_group_id(mut self, group_id: GroupId) -> Self {
+            self.group = Some(group_id);
+            self
+        }
     }
 
 
@@ -505,23 +515,23 @@ mod unix {
     pub struct Args {
         /// The file for keep the daemon process's PID in
         #[arg(long, value_name = "PATH")]
-        pid_file: Option<ConfigPath>,
+        pub pid_file: Option<ConfigPath>,
 
         /// The working directory of the daemon process
         #[arg(long, value_name = "PATH")]
-        working_dir: Option<ConfigPath>,
+        pub working_dir: Option<ConfigPath>,
 
         /// Root directory for the daemon process
         #[arg(long, value_name = "PATH")]
-        chroot: Option<ConfigPath>,
+        pub chroot: Option<ConfigPath>,
 
         /// User for the daemon process
         #[arg(long, value_name = "UID")]
-        user: Option<UserId>,
+        pub user: Option<UserId>,
 
         /// Group for the daemon process
         #[arg(long, value_name = "GID")]
-        group: Option<GroupId>,
+        pub group: Option<GroupId>,
     }
 
     impl Args {
@@ -536,7 +546,7 @@ mod unix {
     /// A user ID in configuration.
     #[derive(Clone, Debug, Deserialize, Serialize)]
     #[serde(try_from = "String", into = "String", expecting = "a user name")]
-    struct UserId {
+    pub struct UserId {
         /// The user name.
         ///
         /// This is used for error reporting.
@@ -601,7 +611,7 @@ mod unix {
     /// A user ID in configuration.
     #[derive(Clone, Debug, Deserialize, Serialize)]
     #[serde(try_from = "String", into = "String", expecting = "a user name")]
-    struct GroupId {
+    pub struct GroupId {
         /// The group name.
         name: String,