meteoritus 0.2.1

A tus server integration for Rocket framework.
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

use rocket::serde::{Deserialize, Serialize};
use uuid::Uuid;

use crate::fs::metadata::Metadata;
use std::{
    io::{Error, ErrorKind, Result},
    marker::PhantomData,
};

/// Indicates the [`FileInfo`] `Created` state.
#[derive(Default, Debug)]
pub struct Building;

/// Indicates the [`FileInfo`] `Built` state.
#[derive(Default, Debug)]
pub struct Built;

/// Indicates the [`FileInfo`] `Created` state.
#[derive(Default, Debug)]
pub struct Created;

/// Indicates the [`FileInfo`] `Completed` state.
#[derive(Default, Debug)]
pub struct Completed;

/// Indicates the [`FileInfo`] `Terminated` state.
#[derive(Default, Debug)]
pub struct Terminated;

/// A struct representing a file and its metadata during various stages of processing.
///
/// The struct has four possible states: [`Built`], [`Created`], [`Completed`] and [`Terminated`].
/// - [`Built`] - The file instances has been built and is ready to create information on disk.
/// - [`Created`] - The file information has been saved on disk.
/// - [`Completed`] - The file has been fully processed and is ready to be used.
/// - [`Terminated`] - The file has been terminated and is no longer saved on disk.
#[derive(Default, Debug, Serialize, Deserialize)]
#[serde(crate = "rocket::serde")]
pub struct FileInfo<State = Building> {
    id: String,
    file_name: String,
    length: u64,
    offset: u64,
    metadata: Option<Metadata>,

    #[serde(skip)]
    state: PhantomData<State>,
}

impl<State> FileInfo<State> {
    pub fn id(&self) -> &str {
        &self.id
    }

    pub fn length(&self) -> &u64 {
        &self.length
    }

    pub fn metadata(&self) -> &Option<Metadata> {
        &self.metadata
    }
}

impl FileInfo<Building> {
    pub(super) fn new(length: u64) -> Self {
        Self {
            length,
            ..Default::default()
        }
    }

    pub(super) fn with_uuid(self) -> Self {
        self.with_raw_id(Uuid::new_v4().simple().to_string())
    }

    pub(super) fn with_raw_id(mut self, id: String) -> Self {
        self.id = id;
        self
    }

    pub(super) fn with_metadata(mut self, metadata: Metadata) -> Self {
        self.metadata = Some(metadata);
        self
    }

    pub(super) fn build(self) -> FileInfo<Built> {
        FileInfo::<Built> {
            state: std::marker::PhantomData,
            id: self.id,
            length: self.length,
            offset: self.offset,
            metadata: self.metadata,
            file_name: self.file_name,
        }
        /* Consider Update to: #![feature(type_changing_struct_update)]
        FileInfo::<Built> {
            state: std::marker::PhantomData,
            ..self
        } */
    }
}

impl FileInfo<Built> {
    pub(super) fn mark_as_created(self, file_name: &str) -> FileInfo<Created> {
        FileInfo::<Created> {
            file_name: file_name.to_string(),
            state: std::marker::PhantomData,
            id: self.id,
            length: self.length,
            offset: self.offset,
            metadata: self.metadata,
        }
        /* Consider Update to: #![feature(type_changing_struct_update)]
        FileInfo::<Created> {
            file_name: file_name.to_string(),
            state: std::marker::PhantomData,
            ..self
        } */
    }
}

impl FileInfo<Created> {
    pub fn offset(&self) -> &u64 {
        &self.offset
    }

    pub(super) fn set_offset(&mut self, offset: u64) -> Result<()> {
        if offset > self.length {
            return Err(Error::from(ErrorKind::OutOfMemory));
        }

        self.offset = offset;

        Ok(())
    }

    pub(crate) fn check_completion(self) -> Option<FileInfo<Completed>> {
        if self.offset != self.length {
            return None;
        }

        Some(FileInfo::<Completed> {
            state: std::marker::PhantomData,
            id: self.id,
            length: self.length,
            offset: self.offset,
            metadata: self.metadata,
            file_name: self.file_name,
        })
        /* Consider Update to: #![feature(type_changing_struct_update)]
        Some(FileInfo::<Completed> {
            state: std::marker::PhantomData,
            ..self
        }) */
    }
}

impl FileInfo<Completed> {
    /// Returns where the file is located
    pub fn file_name(&self) -> &String {
        &self.file_name
    }
}

impl FileInfo<Terminated> {
    pub fn offset(&self) -> &u64 {
        &self.offset
    }

    /// Returns where the file was located
    pub fn file_name(&self) -> &String {
        &self.file_name
    }
}