Merge #154

154: journal: adjust open() mechanisms to use a builder pattern r=jmesmon a=jmesmon

 - `JournalFiles` doesn't properly cover all inclusions/exclusions
 - The various boolean arguments were leading to "boolean blindness" (ie: lack of clarity in what `open()` call options meant).
 - `OpenOptions`, `OpenFileOptions`, and `OpenDirectoryOptions` are added. These are patterned after `std::fs::OpenOptions`.
 - I've marked the commonly used `Journal::open()` as deprecated (and was somewhat annoyed by rust-lang/rust#47219).
 - I've removed `Journal::open_directory` and `Journal::open_files` entirely. They'll need to use the new `journal::OpenFileOptions` and `journal::OpenDirectoryOptions`.

Co-authored-by: Cody P Schafer <[email protected]>

Author: bors[bot]

.github/workflows/ci.yml renamed to .github/workflows/check.yml

@@ -0,0 +1,40 @@
+on:
+  push:
+    branches-ignore:
+      - '**.tmp'
+
+name: features-check
+
+jobs:
+  check:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: beta
+          override: true
+
+      - name: Install libsystemd-dev
+        run: sudo apt-get install libsystemd-dev
+
+      - name: Check with no-default-features
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --all --no-default-features
+
+      - name: Check with only bus
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --all --no-default-features --features bus
+
+      - name: Check with only journal
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --all --no-default-features --features journal

.github/workflows/features.yml

@@ -22,7 +22,6 @@ memchr = "2.3.4"
 utf8-cstr = "~0.1"
 cstr-argument = "~0.1"
 foreign-types = "0.5.0"
-serde = { version = "1.0", default-features = false, features=["derive"], optional = true}
 #enumflags2 = "^0.5"
 #enumflags2_derive = "^0.5"
 

Cargo.lock

@@ -1,6 +1,7 @@
 status = [
 	"continuous-integration/travis-ci/push",
-	"check"
+	"check",
+	"features-check",
 ]
 cut_body_after = "---"
 delete_merged_branches = true

Cargo.toml

@@ -5,7 +5,7 @@ mod x {
     //! Follow future journal log messages and print up to 100 of them.
     use std::io::ErrorKind;
 
-    use systemd::journal::{Journal, JournalFiles, JournalRecord, JournalSeek};
+    use systemd::journal::{self, JournalRecord, JournalSeek};
     use systemd::Error;
 
     const KEY_UNIT: &str = "_SYSTEMD_UNIT";
@@ -17,9 +17,8 @@ mod x {
         println!("Starting journal-logger");
 
         // Open the journal
-        let runtime_only = false;
-        let local_only = false;
-        let mut reader = Journal::open(JournalFiles::All, runtime_only, local_only)
+        let mut reader = journal::OpenOptions::default()
+            .open()
             .expect("Could not open journal");
 
         // Seek to end of current log to prevent old messages from being printed

bors.toml

@@ -3,7 +3,7 @@
 #[cfg(feature = "journal")]
 mod x {
     //! Follow future journal log messages and print up to 100 of them.
-    use systemd::journal::{Journal, JournalFiles, JournalSeek};
+    use systemd::journal::{self, JournalSeek};
 
     const KEY_UNIT: &str = "_SYSTEMD_UNIT";
     const KEY_MESSAGE: &str = "MESSAGE";
@@ -14,9 +14,8 @@ mod x {
         println!("Starting journal-logger");
 
         // Open the journal
-        let runtime_only = false;
-        let local_only = false;
-        let mut reader = Journal::open(JournalFiles::All, runtime_only, local_only)
+        let mut reader = journal::OpenOptions::default()
+            .open()
             .expect("Could not open journal");
 
         // Seek to end of current log to prevent old messages from being printed

examples/journal-logger.rs

@@ -4,11 +4,13 @@ use super::const_iovec;
 use super::size_t;
 use super::{c_char, c_int, c_void};
 
-pub const SD_JOURNAL_LOCAL_ONLY: c_int = 1;
-pub const SD_JOURNAL_RUNTIME_ONLY: c_int = 2;
-pub const SD_JOURNAL_SYSTEM: c_int = 4;
-pub const SD_JOURNAL_CURRENT_USER: c_int = 8;
-pub const SD_JOURNAL_OS_ROOT: c_int = 16;
+pub const SD_JOURNAL_LOCAL_ONLY: c_int = 1 << 0;
+pub const SD_JOURNAL_RUNTIME_ONLY: c_int = 1 << 1;
+pub const SD_JOURNAL_SYSTEM: c_int = 1 << 2;
+pub const SD_JOURNAL_CURRENT_USER: c_int = 1 << 3;
+pub const SD_JOURNAL_OS_ROOT: c_int = 1 << 4;
+pub const SD_JOURNAL_ALL_NAMESPACES: c_int = 1 << 5;
+pub const SD_JOURNAL_INCLUDE_DEFAULT_NAMESPACE: c_int = 1 << 6;
 
 // Wakeup event types
 pub const SD_JOURNAL_NOP: c_int = 0;
@@ -25,6 +27,11 @@ extern "C" {
     // (we don't need to do c-style format strings)
 
     pub fn sd_journal_open(ret: *mut *mut sd_journal, flags: c_int) -> c_int;
+    pub fn sd_journal_open_namespace(
+        ret: *mut *mut sd_journal,
+        namespace: *const c_char,
+        flags: c_int,
+    ) -> c_int;
     pub fn sd_journal_open_directory(
         ret: *mut *mut sd_journal,
         path: *const c_char,