zbox 0.9.2

ZboxFS is a zero-details, privacy-focused in-app file system.
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

#![allow(clippy::module_inception)]

mod storage;

pub use self::storage::{
    Reader, Storage, StorageRef, WalReader, WalWriter, Writer,
};

#[cfg(feature = "storage-mem")]
mod mem;

#[cfg(feature = "storage-file")]
mod file;

#[cfg(any(feature = "storage-faulty", feature = "storage-zbox-faulty"))]
mod faulty_ctl;

#[cfg(feature = "storage-faulty")]
mod faulty;

#[cfg(any(feature = "storage-faulty", feature = "storage-zbox-faulty"))]
pub use self::faulty_ctl::Controller as FaultyController;

#[cfg(feature = "storage-sqlite")]
mod sqlite;

#[cfg(feature = "storage-redis")]
mod redis;

#[cfg(feature = "storage-zbox")]
mod zbox;

#[cfg(any(feature = "storage-file", feature = "storage-zbox"))]
mod index_mgr;

use std::fmt::Debug;

use base::crypto::{Crypto, Key};
use error::Result;
use trans::Eid;
use volume::address::Span;

/// Storable trait
pub trait Storable: Debug + Send + Sync {
    // check if storage exists
    fn exists(&self) -> Result<bool>;

    // make connection to storage
    fn connect(&mut self, force: bool) -> Result<()>;

    // initial a storage
    fn init(&mut self, crypto: Crypto, key: Key) -> Result<()>;

    // open a storage
    fn open(&mut self, crypto: Crypto, key: Key, force: bool) -> Result<()>;

    // super block read/write, must not buffered
    // write no need to be atomic, but must gurantee any successful
    // write is persistent
    fn get_super_block(&mut self, suffix: u64) -> Result<Vec<u8>>;
    fn put_super_block(&mut self, super_blk: &[u8], suffix: u64) -> Result<()>;

    // wal read/write, must not buffered
    // update no need to be atomic, but must gurantee any successful update
    // is persistent.
    // Note: wal deletion doesn't need to be persistent and can be buffered
    fn get_wal(&mut self, id: &Eid) -> Result<Vec<u8>>;
    fn put_wal(&mut self, id: &Eid, wal: &[u8]) -> Result<()>;
    fn del_wal(&mut self, id: &Eid) -> Result<()>;

    // address read/write, can be buffered
    // storage doesn't need to gurantee update is persistent
    fn get_address(&mut self, id: &Eid) -> Result<Vec<u8>>;
    fn put_address(&mut self, id: &Eid, addr: &[u8]) -> Result<()>;
    fn del_address(&mut self, id: &Eid) -> Result<()>;

    // block read/write, can be buffered
    // storage doesn't need to gurantee update is persistent
    fn get_blocks(&mut self, dst: &mut [u8], span: Span) -> Result<()>;
    fn put_blocks(&mut self, span: Span, blks: &[u8]) -> Result<()>;
    fn del_blocks(&mut self, span: Span) -> Result<()>;

    // flush possibly buffered wal, address and block to storage,
    // storage must gurantee write is persistent
    fn flush(&mut self) -> Result<()>;

    // permanently destroy this storage
    fn destroy(&mut self) -> Result<()>;
}

/// Dummy storage
#[derive(Debug, Default)]
pub struct DummyStorage;

impl Storable for DummyStorage {
    #[inline]
    fn exists(&self) -> Result<bool> {
        unimplemented!()
    }

    #[inline]
    fn connect(&mut self, _force: bool) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn init(&mut self, _crypto: Crypto, _key: Key) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn open(&mut self, _crypto: Crypto, _key: Key, _force: bool) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn get_super_block(&mut self, _suffix: u64) -> Result<Vec<u8>> {
        unimplemented!()
    }

    #[inline]
    fn put_super_block(
        &mut self,
        _super_blk: &[u8],
        _suffix: u64,
    ) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn get_wal(&mut self, _id: &Eid) -> Result<Vec<u8>> {
        unimplemented!()
    }

    #[inline]
    fn put_wal(&mut self, _id: &Eid, _wal: &[u8]) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn del_wal(&mut self, _id: &Eid) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn get_address(&mut self, _id: &Eid) -> Result<Vec<u8>> {
        unimplemented!()
    }

    #[inline]
    fn put_address(&mut self, _id: &Eid, _addr: &[u8]) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn del_address(&mut self, _id: &Eid) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn get_blocks(&mut self, _dst: &mut [u8], _span: Span) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn put_blocks(&mut self, _span: Span, _blks: &[u8]) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn del_blocks(&mut self, _span: Span) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn flush(&mut self) -> Result<()> {
        unimplemented!()
    }

    #[inline]
    fn destroy(&mut self) -> Result<()> {
        unimplemented!()
    }
}