desox/file/
mod.rs

1// {{{ Copyright (c) Paul R. Tagliamonte <paultag@gmail.com>, 2026
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19// THE SOFTWARE. }}}
20
21mod communication;
22mod permissions;
23mod r#type;
24
25pub use communication::FileCommunication;
26pub use permissions::FilePermissions;
27pub use r#type::FileType;
28
29/// File settings
30#[derive(Copy, Clone, Debug, PartialEq)]
31pub enum FileSettings {
32    /// File Settings for a Data File
33    Data {
34        /// File Communication
35        communication: FileCommunication,
36
37        /// File Permissions
38        permissions: FilePermissions,
39
40        /// File Size
41        size: u32,
42    },
43
44    /// File Settings for a Backup File
45    Backup {
46        /// File Communication
47        communication: FileCommunication,
48
49        /// File Permissions
50        permissions: FilePermissions,
51
52        /// File Size
53        size: u32,
54    },
55}
56
57impl FileSettings {
58    /// Return the [FileType] for the underlying File.
59    pub fn type_(&self) -> FileType {
60        match self {
61            Self::Data { .. } => FileType::Data,
62            Self::Backup { .. } => FileType::Backup,
63        }
64    }
65
66    /// Return the [FileType] for the underlying File.
67    pub fn communication(&self) -> FileCommunication {
68        match self {
69            Self::Data { communication, .. } => *communication,
70            Self::Backup { communication, .. } => *communication,
71        }
72    }
73
74    /// Return the [FilePermissions] for a file
75    pub fn permissions(&self) -> FilePermissions {
76        match self {
77            Self::Data { permissions, .. } => *permissions,
78            Self::Backup { permissions, .. } => *permissions,
79        }
80    }
81}
82
83// vim: foldmethod=marker
desox/file/mod.rs

desox/file/
mod.rs
