StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
buffered_file_reader.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 {
99 public:
106 public:
112
118 template<typename... Knobs>
119 Parameters(Knobs... knobs): BufferedLocationReader::Parameters(std::move(knobs)...) {}
120
125 Parameters(const Parameters& other) = default;
126
131 Parameters(Parameters&& other) noexcept = default;
132
136 ~Parameters() noexcept = default;
137
143 Parameters& operator=(const Parameters& other) = default;
144
150 Parameters& operator=(Parameters&& other) noexcept = default;
151 };
152
157
168 Parameters parameters = {}):
169 BufferedFileReader(std::move(path),
170 Unpacked(parameters, StormByte::ByteSize{1024ull * 1024ull})) {}
171
176
182
186 ~BufferedFileReader() noexcept override;
187
192 BufferedFileReader& operator=(const BufferedFileReader&) = delete;
193
199 BufferedFileReader& operator=(BufferedFileReader&& other) noexcept;
200
204
205 protected:
212 StormByte::Safe::Shared<StormByte::System::Device> OriginDevice() const override;
213
218 Result OriginOpen() override;
219
224 Result OriginClose() override;
225
233
240 Result OriginSeek(std::ptrdiff_t offset, Position mode) override;
241
246 StormByte::Safe::Optional<StormByte::ByteSize> OriginSize() const noexcept override;
247
248 private:
254 BufferedFileReader(StormByte::Safe::String path, Unpacked knobs);
255
259 std::ifstream m_file;
263 StormByte::Safe::Optional<StormByte::ByteSize> m_size;
267 mutable std::mutex m_file_mutex;
268 };
269 }
270 }
271}
272
273STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::IO::BufferedFileReader);
Byte-oriented FIFO buffer with grow-on-demand and close/error support.
Definition fifo.hxx:86
File-reader knobs.
Definition buffered_file_reader.hxx:105
Parameters()
Construct an empty Safe-owned parameter bag.
Definition buffered_file_reader.hxx:111
Parameters(Parameters &&other) noexcept=default
Transfer Safe-owned knobs.
Parameters(Knobs... knobs)
Store reader knobs in Safe-owned optional values.
Definition buffered_file_reader.hxx:119
~Parameters() noexcept=default
Release knobs through provider callbacks.
Parameters(const Parameters &other)=default
Copy Safe-owned knobs; may allocate and throw.
Final BufferedLocationReader over a filesystem file.
Definition buffered_file_reader.hxx:98
Result OriginClose() override
Close the file stream.
Result OriginOpen() override
Open the file as a binary input and cache its size.
StormByte::Safe::Optional< StormByte::ByteSize > OriginSize() const noexcept override
Cached file size.
STORMBYTE_FORCE_INLINE BufferedFileReader(StormByte::Safe::String path, Parameters parameters={})
Store the path and optional knobs.
Definition buffered_file_reader.hxx:167
~BufferedFileReader() noexcept override
Destructor.
StormByte::Safe::Shared< StormByte::System::Device > OriginDevice() const override
Device for the location probe.
Result OriginSeek(std::ptrdiff_t offset, Position mode) override
Seek the file stream.
Result OriginPull(StormByte::ByteSize n, FIFO &dest) override
Read up to n bytes from the file into dest.
BufferedFileReader(const BufferedFileReader &)=delete
Copy constructor is deleted.
BufferedFileReader(BufferedFileReader &&other) noexcept
Move constructor.
Location-reader knobs.
Definition buffered_location_reader.hxx:129
StormByte::Safe::Shared< StormByte::System::Device > Device() const
Measurement of this location.
BufferedLocationReader(const BufferedLocationReader &)=delete
Copy constructor is deleted.
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Buffered binary sources and sinks.
Buffer module of the StormByte suite.
Position
Forward declaration of the WriteOnly interface.
Definition typedefs.hxx:74
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_FORCE_INLINE
Knobs after Parameters has been unpacked.
Definition buffered_location_reader.hxx:221
Per-call status plus how many bytes this call transferred.
Definition typedefs.hxx:214
#define STORMBYTE_BUFFER_PUBLIC
Definition visibility.h:54