rdedup-lib 3.2.0

Data deduplication with compression and public key encryption. - library
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

use std::io;
use std::path::PathBuf;
use std::sync::mpsc;

use sgdata::SGData;

/// A lock held on the backend
///
/// It doesn't do much, except unlock on `drop`.
pub trait Lock {}

/// Backend API
///
/// Backend is thread-safe, and the actual work
/// is implemented by per-thread instances of it.
pub trait Backend: Send + Sync {
    /// Lock the repository exclusively
    ///
    /// Use to protect operations that are potentially destructive,
    /// like GC.
    fn lock_exclusive(&self) -> io::Result<Box<dyn Lock>>;
    /// Lock the repository in shared mode
    ///
    /// This will only prevent anyone from grabing exclusive lock.
    /// Use to protect operations that only add new data, like `write`.
    fn lock_shared(&self) -> io::Result<Box<dyn Lock>>;

    /// Spawn a new thread object of the backend.
    fn new_thread(&self) -> io::Result<Box<dyn BackendThread>>;
}

pub trait BackendThread: Send {
    fn remove_dir_all(&mut self, path: PathBuf) -> io::Result<()>;

    fn rename(
        &mut self,
        src_path: PathBuf,
        dst_path: PathBuf,
    ) -> io::Result<()>;

    fn write(
        &mut self,
        path: PathBuf,
        sg: SGData,
        idempotent: bool,
    ) -> io::Result<()>;

    fn read(&mut self, path: PathBuf) -> io::Result<SGData>;

    fn remove(&mut self, path: PathBuf) -> io::Result<()>;

    fn read_metadata(&mut self, path: PathBuf) -> io::Result<super::Metadata>;
    fn list(&mut self, path: PathBuf) -> io::Result<Vec<PathBuf>>;

    fn list_recursively(
        &mut self,
        path: PathBuf,
        tx: mpsc::Sender<io::Result<Vec<PathBuf>>>,
    );
}