StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
buffered_file_writer.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Buffer.
5 *
6 * StormByte-Buffer original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Buffer source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte-Logger tree and
23 * the rest of the StormByte suite it vendors), which remains under its own
24 * license.
25 *
26 * Neither license grants any patent rights. Any patent licenses required
27 * to use this software or third-party components must be obtained separately
28 * from the patent holders.
29 *
30 * StormByte-Buffer is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU Lesser General Public License for more details.
34 *
35 * You should have received a copy of the GNU Lesser General Public License
36 * version 3 along with StormByte-Buffer. If not, see
37 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
38 *
39 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
40 */
41
42#pragma once
43
44#include <StormByte/type_traits/safe.hxx>
45
48
49#include <chrono>
50#include <fstream>
51#include <mutex>
52#include <utility>
53
58namespace StormByte {
63 namespace Buffer {
68 namespace IO {
102 public:
109 public:
115
121 template<typename... Knobs>
122 Parameters(Knobs... knobs): BufferedLocationWriter::Parameters(std::move(knobs)...) {}
123
128 Parameters(const Parameters& other) = default;
129
134 Parameters(Parameters&& other) noexcept = default;
135
139 ~Parameters() noexcept = default;
140
146 Parameters& operator=(const Parameters& other) = default;
147
153 Parameters& operator=(Parameters&& other) noexcept = default;
154 };
155
160
173 Parameters parameters = {}):
174 BufferedFileWriter(std::move(path), Unpacked(parameters)) {}
175
180
186
190 ~BufferedFileWriter() noexcept override;
191
196 BufferedFileWriter& operator=(const BufferedFileWriter&) = delete;
197
203 BufferedFileWriter& operator=(BufferedFileWriter&& other) noexcept;
204
208
209 protected:
216 StormByte::Safe::Shared<StormByte::System::Device> OriginDevice() const override;
217
222 StormByte::ByteSize OriginSize() const noexcept override;
223
231 Result OriginOpen() override;
232
237 Result OriginClose() override;
238
244 Result OriginPush(std::span<const std::byte> data) override;
245
250 Result OriginFlush() override;
251
257
263 Result OriginSeek(StormByte::ByteSize absolute) override;
264
270 bool WillWrite(StormByte::ByteSize n) const override;
271
272 private:
278 BufferedFileWriter(StormByte::Safe::String path, Unpacked knobs);
279
283 std::ofstream m_file;
287 mutable std::mutex m_file_mutex;
288 };
289 }
290 }
291}
292
293STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::IO::BufferedFileWriter);
File-writer knobs.
Definition buffered_file_writer.hxx:108
Parameters()
Construct an empty Safe-owned parameter bag.
Definition buffered_file_writer.hxx:114
Parameters(Knobs... knobs)
Store writer knobs in Safe-owned optional values.
Definition buffered_file_writer.hxx:122
~Parameters() noexcept=default
Release knobs through provider callbacks.
Parameters(Parameters &&other) noexcept=default
Transfer Safe-owned knobs.
Parameters(const Parameters &other)=default
Copy Safe-owned knobs; may allocate and throw.
Final BufferedLocationWriter over a filesystem file.
Definition buffered_file_writer.hxx:101
Result OriginSeek(StormByte::ByteSize absolute) override
Seek the file stream to an absolute byte offset.
Result OriginClose() override
Close the file stream.
StormByte::ByteSize OriginSize() const noexcept override
On-disk size or the write cursor, whichever is larger.
Result OriginOpen() override
Open the path for binary random-access write.
StormByte::Safe::Shared< StormByte::System::Device > OriginDevice() const override
Device for the location probe.
Result OriginPush(std::span< const std::byte > data) override
Write data to the file.
~BufferedFileWriter() noexcept override
Destructor.
Result OriginTruncate() override
Resize the file to zero bytes.
bool WillWrite(StormByte::ByteSize n) const override
Whether the volume looks able to accept n more bytes.
BufferedFileWriter(BufferedFileWriter &&other) noexcept
Move constructor.
STORMBYTE_FORCE_INLINE BufferedFileWriter(StormByte::Safe::String path, Parameters parameters={})
Store the path and optional knobs.
Definition buffered_file_writer.hxx:172
BufferedFileWriter(const BufferedFileWriter &)=delete
Copy constructor is deleted.
Result OriginFlush() override
Make written bytes visible to later readers of the path.
Location-writer knobs.
Definition buffered_location_writer.hxx:128
BufferedLocationWriter(const BufferedLocationWriter &)=delete
Copy constructor is deleted.
StormByte::Safe::Shared< StormByte::System::Device > Device() const
Measurement of this location.
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Buffered binary sources and sinks.
Buffer module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_FORCE_INLINE
Knobs after Parameters has been unpacked.
Definition buffered_location_writer.hxx:238
Per-call status plus how many bytes this call transferred.
Definition typedefs.hxx:214
#define STORMBYTE_BUFFER_PUBLIC
Definition visibility.h:54