sfsdb 0.1.0

A simple, optionally cached and indexed, extensible file-system database you already know how to use
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
114
115
116
117
118
119
120
121

use serde::{Deserialize, Serialize};
use sfsdb::GenericDatabase;
use std::fs;
use std::time::SystemTime;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct User {
    pub name: String,
    pub age: u64,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct MyIndex {
    pub login_attempts: u16,
    pub logged_in: bool,
}

/*
 * For an more in-depth explenation of the different kinds of databases
 * view their respective examples.
 */

fn main() {
    let mut db_uncached = sfsdb::new("db_simple");
    let mut db_indexed = sfsdb::new_indexed::<MyIndex>("db_indexed", Some(20), 100);
    let mut db_cached = sfsdb::new_cached("db_cached", Some(20), 100);

    let justin = User {
        name: "Justin Evans".to_string(),
        age: 22,
    };

    // Creating in an uncached database
    bench(&mut db_uncached, |db| {
        for i in 0..1000 {
            db.save(&i.to_string(), &justin).unwrap();
        }
        print!("\n(Simple) Saving justin 1000 times took: ");
    });
    // Loading from an uncached database
    bench(&mut db_uncached, |db| {
        for _i in 0..1000 {
            // If I'd instead load i, so it loaded a different one every single time the
            // performance improvements of caching wouldn't show
            let _justin = db.load::<User>("400").unwrap();
        }
        print!("(Simple) Loading justin (with key '400') 1000 times took: ");
    });

    // Creating in an cached database
    bench(&mut db_cached, |db| {
        for i in 0..1000 {
            db.save(&i.to_string(), &justin).unwrap();
        }
        print!("\n(Cached) Saving justin 1000 times took: ");
    });
    // Loading from an cached database
    bench(&mut db_cached, |db| {
        for _i in 0..1000 {
            // If I'd instead load i, so it loaded a different one every single time the
            // performance improvements of caching wouldn't show
            let _justin = db.load::<User>("400").unwrap();
        }
        print!("(Cached) Loading justin (with key '400') 1000 times took: ");
    });

    // Creating in an indexed database
    bench(&mut db_indexed, |db| {
        for i in 0..1000 {
            // For this example, even numbers means he's logged in
            // For this example, key in database is the login attempts
            db.save_with_index(
                &i.to_string(),
                &justin,
                MyIndex {
                    login_attempts: i,
                    logged_in: (i % 2 == 0),
                },
            )
            .unwrap();
        }
        print!("\n(Indexed + Cached) Saving justin 1000 times took: ");
    });
    // Loading from an cached database
    bench(&mut db_indexed, |db| {
        for _i in 0..1000 {
            // If I'd instead load i, so it loaded a different one every single time the
            // performance improvements of caching wouldn't show
            let _justin = db.load::<User>("400").unwrap();
        }
        print!("(Indexed + Cached) Loading justin (with key '400') 1000 times took: ");
    });
    // Dispatching index query actions
    bench(&mut db_indexed, |db| {
        let logged_in_users = db.search_with(|i| i.logged_in);
        print!(
            "(Indexed + Cached) Querying for all logged-in users (which yielded {} results) took: ",
            logged_in_users.len()
        );
    });
    bench(&mut db_indexed, |db| {
        let locked_out_users = db.search_with(|i| i.login_attempts > 820);
        print!(
            "(Indexed + Cached) Querying for all locked-out users (which yielded {} results) took: ",
            locked_out_users.len()
        );
    });

    for db in &["db_simple", "db_cached", "db_indexed"] {
        fs::remove_dir_all(db).ok();
    }
}

fn bench<T, F>(db: &mut T, mut action: F)
where
    F: FnMut(&mut T),
{
    let t = SystemTime::now();
    action(db);
    print!("{:?}\n", t.elapsed().unwrap());
}