libfilezilla
file.hpp
Go to the documentation of this file.
1#ifndef LIBFILEZILLA_FILE_HEADER
2#define LIBFILEZILLA_FILE_HEADER
3
4#include "libfilezilla.hpp"
5
6#ifdef FZ_WINDOWS
7#include "glue/windows.hpp"
8#endif
9
14#include <stdint.h>
15
16namespace fz {
17
25class FZ_PUBLIC_SYMBOL file final
26{
27public:
29 enum mode {
30 reading,
31 writing
32 };
33
42 existing = 0x1,
43
45 empty = 0x2,
46
53 current_user_only = 0x4,
54
65 current_user_and_admins_only = 0x8
66 };
67
68 file() = default;
69 file(native_string const& f, mode m, creation_flags d = existing);
70
71 ~file();
72
73 file(file const&) = delete;
74 file& operator=(file const&) = delete;
75
76 bool opened() const;
77
78 bool open(native_string const& f, mode m, creation_flags d = existing);
79
80 void close();
81
83 enum seek_mode {
86
89
91 end
92 };
93
97 int64_t size() const;
98
111 int64_t seek(int64_t offset, seek_mode m);
112
114 int64_t position() { return seek(0, current); }
115
121 bool truncate();
122
136 int64_t read(void *buf, int64_t count);
137
148 int64_t write(void const* buf, int64_t count);
149
155 bool fsync();
156
157private:
158#ifdef FZ_WINDOWS
159 HANDLE hFile_{INVALID_HANDLE_VALUE};
160#else
161 int fd_{-1};
162#endif
163};
164
169bool FZ_PUBLIC_SYMBOL remove_file(native_string const& name);
170
172 return static_cast<file::creation_flags>(static_cast<unsigned int>(lhs) | rhs);
173}
174
175}
176#endif
Lean class for file access.
Definition: file.hpp:26
mode
Files can be opened for reading or writing, but not both.
Definition: file.hpp:29
creation_flags
Creation flags when opening file for writing.
Definition: file.hpp:40
int64_t seek(int64_t offset, seek_mode m)
Relative seek based on seek mode.
int64_t write(void const *buf, int64_t count)
Write data to file.
int64_t read(void *buf, int64_t count)
Read data from file.
bool truncate()
Truncate the file to the current position of the file pointer.
int64_t size() const
Gets size of file.
seek_mode
Used by seek.
Definition: file.hpp:83
@ begin
Seek from beginning of file.
Definition: file.hpp:85
@ current
Seek from current position in the file.
Definition: file.hpp:88
int64_t position()
Get Current position in file.
Definition: file.hpp:114
bool fsync()
Ensure data is flushed to disk.
Sets some global macros and further includes string.hpp.
The namespace used by libfilezilla.
Definition: apply.hpp:17
bool remove_file(native_string const &name)
remove the specified file.
std::wstring native_string
A string in the system's native character type and encoding. Note: This typedef changes depending on...
Definition: string.hpp:33