zebo 0.4.8

Write data on FS in a performance way
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

# Zebo

[![Rust](https://github.com/oramasearch/zebo/actions/workflows/ci.yml/badge.svg)](https://github.com/oramasearch/zebo/actions/workflows/ci.yml)

Zebo is a simple library that help you to write data on FS effectively.
It groups your data in files according to the limitations you imposed.

## Usage

To use this crate, add the following to your `Cargo.toml`:

```toml
[dev-dependencies]
zebo = "*"
```

```rust
use zebo::Zebo;

fn main() {
    let data_dir = "./zebo_data_dir";
    let mut zebo = Zebo::<
        // Max number of documents per file
        10,
        // Max number of bytes per file
        1024,
        // Document ID type
        u32,
    >::try_new(data_dir)
    .expect("Failed to create Zebo instance");

    // Batch insertions
    zebo.add_documents_batch(vec![
        (1, b"Document 1".to_vec()),
        (2, b"Document 2".to_vec()),
        (3, b"Document 3".to_vec()),
    ], 200, 1024)
    .expect("Failed to add documents");

    // Simple insertions
    zebo.add_documents(vec![
        (4, b"Document 4".repeat(100)),
        (5, b"Document 5".to_vec()),
    ])
    .expect("Failed to add documents");

    let mut docs = zebo.get_documents(vec![1, 3, 5])
        .unwrap();
    while let Some(Ok((doc_id, doc))) = docs.next() {
        println!("Document ({doc_id}): {:?}", String::from_utf8(doc));
    }
}
```