tfio 0.3.0

A library that provides a Transaction-like interface traditionally used in databases, applied to 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
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

use std::env;
use std::path::{Path, PathBuf};

use uuid::Uuid;

use super::{
    async_copy_dir, cleanup_backup_dir, cleanup_backup_file, AsyncOpFuture,
    AsyncRollbackableOperation,
};

/// Asynchronously copies a file to the destination.
///
/// If the destination already exists it is backed up and restored on rollback.
pub struct AsyncCopyFile {
    source: PathBuf,
    dest: PathBuf,
    temp_dir: PathBuf,
    backup_path: PathBuf,
    dest_existed: bool,
}

impl AsyncCopyFile {
    /// Constructs a new `AsyncCopyFile` operation, using the OS temp directory for backups.
    pub fn new<S: AsRef<Path>, T: AsRef<Path>>(source: S, dest: T) -> Self {
        Self::with_temp_dir(source, dest, env::temp_dir())
    }

    /// Constructs a new `AsyncCopyFile` operation with a custom backup directory.
    pub fn with_temp_dir<S: AsRef<Path>, T: AsRef<Path>, U: AsRef<Path>>(
        source: S,
        dest: T,
        temp_dir: U,
    ) -> Self {
        Self {
            source: source.as_ref().into(),
            dest: dest.as_ref().into(),
            temp_dir: temp_dir.as_ref().into(),
            backup_path: PathBuf::new(),
            dest_existed: false,
        }
    }
}

impl AsyncRollbackableOperation for AsyncCopyFile {
    fn execute(&mut self) -> AsyncOpFuture<'_> {
        Box::pin(async move {
            if tokio::fs::metadata(&self.dest).await.is_ok() {
                self.dest_existed = true;
                tokio::fs::create_dir_all(&self.temp_dir).await?;
                self.backup_path = self.temp_dir.join(Uuid::new_v4().to_string());
                tokio::fs::copy(&self.dest, &self.backup_path).await?;
            }
            tokio::fs::copy(&self.source, &self.dest).await.map(|_| ())
        })
    }

    fn rollback(&mut self) -> AsyncOpFuture<'_> {
        Box::pin(async move {
            if self.dest_existed {
                tokio::fs::copy(&self.backup_path, &self.dest).await.map(|_| ())
            } else {
                match tokio::fs::remove_file(&self.dest).await {
                    Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(()),
                    other => other,
                }
            }
        })
    }
}

impl Drop for AsyncCopyFile {
    fn drop(&mut self) {
        cleanup_backup_file(&self.backup_path);
    }
}

/// Asynchronously copies a directory to the destination.
///
/// If the destination already exists it is backed up and restored on rollback.
pub struct AsyncCopyDirectory {
    source: PathBuf,
    dest: PathBuf,
    temp_dir: PathBuf,
    backup_path: PathBuf,
    dest_existed: bool,
}

impl AsyncCopyDirectory {
    /// Constructs a new `AsyncCopyDirectory` operation, using the OS temp directory for backups.
    pub fn new<S: AsRef<Path>, T: AsRef<Path>>(source: S, dest: T) -> Self {
        Self::with_temp_dir(source, dest, env::temp_dir())
    }

    /// Constructs a new `AsyncCopyDirectory` operation with a custom backup directory.
    pub fn with_temp_dir<S: AsRef<Path>, T: AsRef<Path>, U: AsRef<Path>>(
        source: S,
        dest: T,
        temp_dir: U,
    ) -> Self {
        Self {
            source: source.as_ref().into(),
            dest: dest.as_ref().into(),
            temp_dir: temp_dir.as_ref().into(),
            backup_path: PathBuf::new(),
            dest_existed: false,
        }
    }
}

impl AsyncRollbackableOperation for AsyncCopyDirectory {
    fn execute(&mut self) -> AsyncOpFuture<'_> {
        Box::pin(async move {
            if tokio::fs::metadata(&self.dest).await.is_ok() {
                self.dest_existed = true;
                tokio::fs::create_dir_all(&self.temp_dir).await?;
                self.backup_path = self.temp_dir.join(Uuid::new_v4().to_string());
                async_copy_dir(&self.dest, &self.backup_path).await?;
            }
            async_copy_dir(&self.source, &self.dest).await
        })
    }

    fn rollback(&mut self) -> AsyncOpFuture<'_> {
        Box::pin(async move {
            if self.dest_existed {
                tokio::fs::remove_dir_all(&self.dest).await?;
                async_copy_dir(&self.backup_path, &self.dest).await
            } else {
                match tokio::fs::remove_dir_all(&self.dest).await {
                    Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(()),
                    other => other,
                }
            }
        })
    }
}

impl Drop for AsyncCopyDirectory {
    fn drop(&mut self) {
        cleanup_backup_dir(&self.backup_path);
    }
}