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
|
/*
* libfud
* Copyright 2024 Dominick Allen
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FUD_FILE_HPP
#define FUD_FILE_HPP
#include "fud_allocator.hpp"
#include "fud_option.hpp"
#include "fud_permissions.hpp"
#include "fud_result.hpp"
#include "fud_status.hpp"
#include "fud_string_view.hpp"
#include <fcntl.h>
namespace fud {
/** \brief Access Modes for File */
enum class FileAccessMode : uint8_t
{
Read = 0x01,
Write = 0x02,
ReadWrite = Read | Write
};
enum class OpenFlagEnum : uint32_t
{
Append = O_APPEND,
Truncate = O_TRUNC,
CloseOnExec = O_CLOEXEC,
DataSync = O_DSYNC,
Direct = O_DIRECT,
NoAtime = O_NOATIME,
NonBlock = O_NONBLOCK,
FileSync = O_SYNC
};
class OpenFlags {
public:
using FlagType = std::underlying_type_t<OpenFlagEnum>;
constexpr OpenFlags() noexcept = default;
constexpr OpenFlags(const OpenFlags& rhs) noexcept = default;
constexpr OpenFlags(OpenFlags&& rhs) noexcept = default;
constexpr ~OpenFlags() noexcept = default;
constexpr OpenFlags& operator=(const OpenFlags& rhs) noexcept = default;
constexpr OpenFlags& operator=(OpenFlags&& rhs) noexcept = default;
constexpr OpenFlags(OpenFlagEnum mode) noexcept : m_mask{static_cast<FlagType>(mode)}
{
}
constexpr OpenFlags operator|(OpenFlags rhs) const noexcept
{
OpenFlags mode{*this};
mode.m_mask |= rhs.m_mask;
return mode;
}
constexpr OpenFlags& operator|=(OpenFlags rhs) noexcept
{
m_mask |= rhs.m_mask;
return *this;
}
constexpr OpenFlags& operator|=(OpenFlagEnum rhs) noexcept
{
m_mask |= static_cast<FlagType>(rhs);
return *this;
}
constexpr OpenFlags operator|(OpenFlagEnum rhs) const noexcept
{
OpenFlags mode{*this};
mode.m_mask |= static_cast<FlagType>(rhs);
return mode;
}
constexpr FlagType flags() const noexcept
{
return m_mask;
}
constexpr bool hasFlag(OpenFlagEnum flag) noexcept
{
return (m_mask & static_cast<FlagType>(flag)) != 0;
}
private:
FlagType m_mask{0};
};
constexpr OpenFlags operator|(OpenFlagEnum lhs, OpenFlagEnum rhs)
{
OpenFlags mode{lhs};
return mode | rhs;
}
struct [[nodiscard]] ReadResult {
size_t bytesRead{0};
FudStatus status{FudStatus::Success};
};
struct [[nodiscard]] WriteResult {
size_t bytesWritten{0};
FudStatus status{FudStatus::Success};
};
class RegularFile;
using FileResult = Result<RegularFile, FudStatus>;
class RegularFile {
public:
static FileResult open(
StringView filename,
FileAccessMode mode,
OpenFlags flags,
Option<int> dirFdoption,
Allocator* allocator = &globalFudAllocator);
static FileResult create(
StringView filename,
FileAccessMode mode,
OpenFlags flags,
Permissions permissions,
bool exclusive,
Option<int> dirFdOption,
Allocator* allocator = &globalFudAllocator);
FudStatus close();
FudStatus take(RegularFile& rhs);
Result<size_t, FudStatus> size() const;
private:
RegularFile() = default;
public:
RegularFile(const RegularFile& rhs) = delete;
RegularFile(RegularFile&& rhs) noexcept;
~RegularFile();
RegularFile& operator=(const RegularFile& rhs) = delete;
RegularFile& operator=(RegularFile&& rhs) noexcept;
private:
int m_fd{-1};
FileAccessMode m_modeFlags{};
OpenFlags m_openFlags{};
};
} // namespace fud
#endif
|
