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
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

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

use std::collections::HashMap;

use io_fs::{
    coroutines::{create_dir::CreateDir, create_files::CreateFiles},
    error::{FsError, FsResult},
    io::FsIo,
};
use thiserror::Error;

use crate::{
    collection::Collection,
    constants::{COLOR, DESCRIPTION, DISPLAYNAME},
};

/// Errors that can occur during the coroutine progression.
#[derive(Clone, Debug, Error)]
pub enum CreateCollectionError {
    /// An error occured during the directory creation.
    #[error("Create Vdir collection error")]
    CreateDirError(#[source] FsError),

    /// An error occured during the metadata files creation.
    #[error("Create Vdir metadata error")]
    CreateFilesError(#[source] FsError),
}

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

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

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

#[derive(Debug)]
enum State {
    CreateCollection(CreateDir),
    CreateMetadataFiles(CreateFiles),
}

/// I/O-free coroutine to create a Vdir collection.
#[derive(Debug)]
pub struct CreateCollection {
    collection: Collection,
    state: State,
}

impl CreateCollection {
    /// Creates a new coroutine from the given collection.
    pub fn new(collection: Collection) -> Self {
        let fs = CreateDir::new(&collection.path);
        let state = State::CreateCollection(fs);

        Self { collection, state }
    }

    /// Makes the coroutine progress.
    pub fn resume(&mut self, mut arg: Option<FsIo>) -> CreateCollectionResult {
        loop {
            match &mut self.state {
                State::CreateCollection(fs) => {
                    match fs.resume(arg.take()) {
                        FsResult::Ok(()) => (),
                        FsResult::Io(io) => break CreateCollectionResult::Io(io),
                        FsResult::Err(err) => {
                            let err = CreateCollectionError::CreateDirError(err);
                            break CreateCollectionResult::Err(err);
                        }
                    };

                    let display_name = self.collection.display_name.clone();
                    let description = self.collection.description.take();
                    let color = self.collection.color.take();

                    let mut contents = HashMap::new();

                    if let Some(name) = display_name {
                        contents.insert(self.collection.path.join(DISPLAYNAME), name.into_bytes());
                    }

                    if let Some(desc) = description {
                        contents.insert(self.collection.path.join(DESCRIPTION), desc.into_bytes());
                    }

                    if let Some(color) = color {
                        contents.insert(self.collection.path.join(COLOR), color.into_bytes());
                    }

                    if contents.is_empty() {
                        break CreateCollectionResult::Ok;
                    }

                    let fs = CreateFiles::new(contents);
                    self.state = State::CreateMetadataFiles(fs);
                }
                State::CreateMetadataFiles(fs) => {
                    break match fs.resume(arg.take()) {
                        FsResult::Ok(()) => CreateCollectionResult::Ok,
                        FsResult::Io(io) => CreateCollectionResult::Io(io),
                        FsResult::Err(err) => {
                            let err = CreateCollectionError::CreateFilesError(err);
                            CreateCollectionResult::Err(err)
                        }
                    }
                }
            }
        }
    }
}