disk_log 0.1.0

disk_log is a **High Throughout, NonBlocking** Disk-based logger
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113


<div align="center">

  <!-- Downloads -->
  <a href="https://crates.io/crates/disk_log">
    <img src="https://img.shields.io/crates/d/disk_log.svg?style=flat-square"
      alt="Download" />
  </a>
</div>

# disk_log


disk_log is a **High Throughout, NonBlocking** Disk-based logger


# Way need to disk_log ?

* **Non Blocking** - optimized for tokio and
  **don't block your scheduler** for IO operation 


* **Paging** - disk_log distribute logs records between pages/files
  by `total_page_size`


* **Iterator** - provide asynchronous function `get_page` then 
  can iterate whole page **(its safe for concurrent reading when disk_log write to it)**  


* **High Concurrency** disk_log don't need to
  Mutex/RwLock for sharing between threads, its complete safe


* **Technically** - disk_log inspired by **erlang disk_log**
  that is a heavily used in erlang , by **mnesia database**
  and **Logger** (Logger is production used Logger for Elixir) 




# Example 

```rust

#[tokio::main]
async fn main() {

  let path = ".";
  let name = "service";
  let total_page_size = 1000;

  // Run DiskLog and get session
  let sess = DiskLog::open(path, name, total_page_size)
                             .unwrap()
                             .run_service();
                             


  // Log to page (don't block your scheduler)

  let _ = sess.log(b"Serialized data ......".to_vec()).await;

  let _ = sess.log(b"Serialized data ......".to_vec()).await;



  // very lightweight, just increment counter (mpsc::sender::clone)
  let sess1 = sess.clone();
  
  
  // Spawn task 
  tokio::spawn(async move {              
   
    // log by another task
    let _ = sess1.log(b"Serialized data ......".to_vec()).await;
  });



  // ---------------------------------------------------------------------
  // asynchronous get page
  let page = sess.get_page(1).await;
  
  match page {
       Err(e) => println!("==> {:?}", e),
       // if exist page
       Ok(mut lf) => {
           lf.iter(..)
             .unwrap()
             .for_each(|_record| {
               // consumer record
             })
       }    
   }

}

```



# Author

- DanyalMh 



## License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.