io-vdir 0.0.1

Set of I/O-free coroutines to manage Vdir filesystems
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

//! I/O-free coroutine to delete a Vdir collection.

use std::path::Path;

use io_fs::{
    coroutines::remove_dir::RemoveDir,
    error::{FsError, FsResult},
    io::FsIo,
};
use thiserror::Error;

/// Errors that can occur during the coroutine progression.
#[derive(Clone, Debug, Error)]
pub enum DeleteCollectionError {
    /// An error occured during the directory deletion.
    #[error("Delete Vdir collection error")]
    RemoveDirError(#[from] FsError),
}

/// Output emitted when the coroutine terminates its progression.
#[derive(Clone, Debug)]
pub enum DeleteCollectionResult {
    /// The coroutine successfully terminated its progression.
    Ok,

    /// The coroutine encountered an error.
    Err(DeleteCollectionError),

    /// An I/O needs to be processed in order to make the coroutine
    /// progress further.
    Io(FsIo),
}

/// I/O-free coroutine to delete a Vdir collection.
#[derive(Debug)]
pub struct DeleteCollection(RemoveDir);

impl DeleteCollection {
    /// Creates a new coroutine from the given collection's path.
    pub fn new(path: impl AsRef<Path>) -> Self {
        Self(RemoveDir::new(path.as_ref()))
    }

    /// Makes the coroutine progress.
    pub fn resume(&mut self, arg: Option<FsIo>) -> DeleteCollectionResult {
        match self.0.resume(arg) {
            FsResult::Ok(()) => DeleteCollectionResult::Ok,
            FsResult::Err(err) => DeleteCollectionResult::Err(err.into()),
            FsResult::Io(io) => DeleteCollectionResult::Io(io),
        }
    }
}