zbox 0.3.0

Zbox is a zero-details, privacy-focused embeddable 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

mod file;
mod mem;

use std::fmt::Debug;
use std::io::Result as IoResult;

use error::Result;
use base::crypto::{Crypto, Key};
use trans::{Eid, Txid};

pub use self::file::FileStorage;
pub use self::mem::MemStorage;

/// Storage trait
pub trait Storage: Debug {
    /// Check if storage exists
    fn exists(&self, location: &str) -> bool;

    // Volume initialisation
    // ------------------------
    /// Initialise storage with storage key and volume header
    fn init(
        &mut self,
        volume_id: &Eid,
        crypto: &Crypto,
        skey: &Key,
    ) -> Result<()>;

    // Super block read/write
    // ------------------------
    /// Get super block
    fn get_super_blk(&self) -> Result<Vec<u8>>;

    /// Put super block
    fn put_super_blk(&mut self, super_blk: &[u8]) -> Result<()>;

    // Open storage
    // ------------------------
    /// Open storage, return last comitted transaction id
    fn open(
        &mut self,
        volume_id: &Eid,
        crypto: &Crypto,
        skey: &Key,
    ) -> Result<Txid>;

    // Entity read/write/delete
    // ------------------------
    /// Read an entity
    fn read(
        &mut self,
        id: &Eid,
        offset: u64,
        buf: &mut [u8],
        txid: Txid,
    ) -> IoResult<usize>;

    /// Write but to an entity, return how many bytes written
    fn write(
        &mut self,
        id: &Eid,
        offset: u64,
        buf: &[u8],
        txid: Txid,
    ) -> IoResult<usize>;

    /// Delete an entity
    fn del(&mut self, id: &Eid, txid: Txid) -> Result<Option<Eid>>;

    // Transaction
    // ------------------------
    /// Begin transaction
    fn begin_trans(&mut self, txid: Txid) -> Result<()>;

    /// Abort transaction
    ///
    /// If any errors happend between begin_trans() and commit_trans(), this
    /// should be called to abort a transaction.
    fn abort_trans(&mut self, txid: Txid) -> Result<()>;

    /// Commit transaction
    fn commit_trans(&mut self, txid: Txid) -> Result<()>;
}