Merge pull request #1 from rster2002/async

Async implementations for readers

ed-journals/Cargo.toml

@@ -22,7 +22,11 @@ kinded = "0.3.0"
 lazy_static = "1.4.0"
 log = "0.4.21"
 notify = "6.1.1"
+tokio = { version = "1.37.0", features = ["fs", "sync", "io-util"], default-features = false, optional = true }
+async-mutex = { version = "1.4.0", optional = true }
 
 [features]
-default = []
+default = ["async"]
+blocking = []
+async = ["dep:tokio", "dep:async-mutex"]
 strict = []

ed-journals/src/lib.rs

@@ -10,25 +10,30 @@
 //! Currently, the only files that are parsed are the log files. Models for working `Market.json`
 //! and `Status.json` etc will be added in the future. Best place to get started is the [JournalDir]
 //! model.
-
+pub use models::journal_event_content;
 pub use models::journal_dir::JournalDir;
+pub use models::journal_dir::JournalDirError;
+pub use models::journal_file::JournalFile;
+pub use models::journal_file::JournalFileError;
+
 pub use models::journal_event::JournalEvent;
-pub use models::journal_event_content;
 pub use models::journal_event_content::JournalEventContent;
 pub use models::journal_event_content::JournalEventContentKind;
-pub use models::journal_file::JournalFile;
-pub use models::journal_file_reader::JournalFileReader;
-pub use models::live_journal_dir_reader::LiveJournalDirReader;
-pub use models::live_journal_file_reader::LiveJournalFileReader;
+
+#[cfg(feature = "blocking")]
+pub use models::blocking;
+
+#[cfg(feature = "async")]
+pub use models::r#async;
 
 mod macros;
 mod models;
 
 #[cfg(test)]
 mod tests {
     use std::env::current_dir;
+    use crate::blocking::JournalDir;
 
-    use crate::models::journal_dir::JournalDir;
     use crate::models::journal_event_content::JournalEventContent;
 
     #[test]
@@ -49,7 +54,7 @@ mod tests {
         let mut entry_count = 0;
 
         for journal in &logs {
-            let reader = journal.create_reader().unwrap();
+            let reader = journal.create_blocking_reader().unwrap();
 
             for entry in reader {
                 entry_count += 1;

ed-journals/src/models.rs

@@ -1,10 +1,13 @@
-pub mod journal_dir;
 pub mod journal_event;
 
 /// This module contains detailed structs and enums for the different kinds of events that are read
 /// from a [JournalFile].
 pub mod journal_event_content;
+pub mod journal_dir;
 pub mod journal_file;
-pub mod journal_file_reader;
-pub mod live_journal_dir_reader;
-pub mod live_journal_file_reader;
+
+#[cfg(feature = "blocking")]
+pub mod blocking;
+
+#[cfg(feature = "async")]
+pub mod r#async;

ed-journals/src/models/async.rs

@@ -0,0 +1,11 @@
+mod journal_file_reader;
+// mod live_journal_dir_reader;
+mod live_journal_file_reader;
+mod live_journal_dir_reader;
+
+pub use journal_file_reader::JournalFileReader;
+pub use journal_file_reader::JournalFileReaderError;
+pub use live_journal_file_reader::LiveJournalFileReader;
+pub use live_journal_file_reader::LiveJournalFileReaderError;
+pub use live_journal_dir_reader::LiveJournalDirReader;
+pub use live_journal_dir_reader::LiveJournalDirReaderError;