tfio 0.1.32

A library that provides a Transaction-like interface that are traditionally used in databases on FileIO operations.
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

use std::io::{self, Read, Write};
use std::{
    fs::OpenOptions,
    path::{Path, PathBuf},
};

use crate::{RollbackableOperation, SingleFileOperation};

/// Appends data to a file
pub struct AppendFile {
    source: PathBuf,
    temp_dir: PathBuf,
    backup_path: PathBuf,
    data: Vec<u8>,
}

impl AppendFile {
    /// Constructs a new AppendFile operation
    pub fn new<S: AsRef<Path>, T: AsRef<Path>>(source: S, temp_dir: T, data: Vec<u8>) -> Self {
        Self {
            source: source.as_ref().into(),
            temp_dir: temp_dir.as_ref().into(),
            backup_path: PathBuf::new(),
            data,
        }
    }
}

impl RollbackableOperation for AppendFile {
    fn execute(&mut self) -> io::Result<()> {
        self.create_backup_file()?;

        OpenOptions::new()
            .append(true)
            .open(self.get_path())?
            .write_all(&self.data)
    }

    fn rollback(&self) -> io::Result<()> {
        let mut buffer = Vec::<u8>::new();
        let mut backup_file = OpenOptions::new().read(true).open(self.get_backup_path())?;

        backup_file.read_to_end(&mut buffer)?;

        OpenOptions::new()
            .write(true)
            .truncate(true)
            .open(self.get_path())?
            .write_all(&buffer)
    }
}

impl SingleFileOperation for AppendFile {
    fn get_path(&self) -> &Path {
        &self.source
    }

    fn get_backup_path(&self) -> &Path {
        &self.backup_path
    }

    fn set_backup_path<S: AsRef<Path>>(&mut self, uuid: S) {
        self.backup_path = uuid.as_ref().into();
    }

    fn get_temp_dir(&self) -> &Path {
        &self.temp_dir
    }
}

impl Drop for AppendFile {
    fn drop(&mut self) {
        match self.dispose() {
            Err(e) => eprintln!("{}", e),
            _ => {}
        }
    }
}

#[cfg(test)]
mod tests {
    use std::fs::{self, File};
    use std::io;

    use super::*;

    const FILE_SOURCE: &str = "./append.txt";
    const TEMP_DIR: &str = "./tmp/";
    const DATA: &[u8] = "Hello World".as_bytes();

    fn setup() -> io::Result<()> {
        match File::create(FILE_SOURCE) {
            Ok(_f) => Ok(()),
            Err(e) => Err(e),
        }
    }

    #[test]
    #[allow(unused_must_use)]
    fn append_file_works() {
        assert_eq!((), setup().expect("Unable to setup test"));

        fs::write(FILE_SOURCE, DATA).expect("Unable to write file");

        let mut op = AppendFile::new(FILE_SOURCE, TEMP_DIR, DATA.to_vec());
        assert_eq!((), op.execute().expect("Unable to perform execute"));

        let data = fs::read_to_string(FILE_SOURCE).expect("Unable to read file");
        assert_eq!(String::from_utf8([DATA, DATA].concat()).unwrap(), data);

        assert_eq!((), op.rollback().expect("Unable to perform rollback"));
        let data = fs::read_to_string(FILE_SOURCE).expect("Unable to read file");
        assert_eq!(String::from_utf8(DATA.to_vec()).unwrap(), data);

        fs::remove_file(FILE_SOURCE);
    }
}