StormByte-Buffer 2.0.0
C++26 buffer module of the StormByte suite
 
Loading...
Searching...
No Matches
exception.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
47
48#include <format>
49#include <string>
50#include <string_view>
51#include <utility>
52
57namespace StormByte::Buffer {
68 public:
75 template <typename... Args>
76 explicit Exception(std::format_string<Args...> fmt, Args&&... args)
77 : StormByte::Exception(StormByte::Exception::Path{"Buffer"}, fmt, std::forward<Args>(args)...) {}
78
83 explicit Exception(std::string message)
84 : Exception("{}", std::move(message)) {}
85
90 explicit Exception(const StormByte::Safe::String& message)
91 : StormByte::Exception(StormByte::Exception::Path{"Buffer"}, "{}", std::string_view(message)) {}
92
96 ~Exception() noexcept override;
97
98 protected:
106 template <typename... Args>
107 explicit Exception(StormByte::Exception::Path child, std::format_string<Args...> fmt, Args&&... args)
109 StormByte::Exception::Path{std::string("Buffer.") + std::string(child.text)},
110 fmt,
111 std::forward<Args>(args)...) {}
112
120 StormByte::Exception::Path{std::string("Buffer.") + std::string(child.text)},
121 "{}",
122 std::string_view(message)) {}
123 };
124
132 public:
133 using Exception::Exception;
134
138 ~Error() noexcept override;
139 };
140
146 public:
153 template <typename... Args>
154 explicit ReadError(std::format_string<Args...> fmt, Args&&... args)
155 : Error(StormByte::Exception::Path{"Read"}, fmt, std::forward<Args>(args)...) {}
156
161 explicit ReadError(std::string message)
162 : ReadError("{}", std::move(message)) {}
163
168 explicit ReadError(const StormByte::Safe::String& message)
169 : Error(StormByte::Exception::Path{"Read"}, "{}", std::string_view(message)) {}
170
174 ~ReadError() noexcept override;
175 };
176
182 public:
189 template <typename... Args>
190 explicit WriteError(std::format_string<Args...> fmt, Args&&... args)
191 : Error(StormByte::Exception::Path{"Write"}, fmt, std::forward<Args>(args)...) {}
192
197 explicit WriteError(std::string message)
198 : WriteError("{}", std::move(message)) {}
199
204 explicit WriteError(const StormByte::Safe::String& message)
205 : Error(StormByte::Exception::Path{"Write"}, "{}", std::string_view(message)) {}
206
210 ~WriteError() noexcept override;
211 };
212}
General exception for buffer errors.
Definition exception.hxx:131
~Error() noexcept override
Destructor.
Root exception for Buffer.
Definition exception.hxx:67
Exception(StormByte::Exception::Path child, const StormByte::Safe::String &message)
Copies Base-owned text under StormByte.Buffer.
Definition exception.hxx:118
Exception(const StormByte::Safe::String &message)
Copies Base-owned text under StormByte.Buffer.
Definition exception.hxx:90
Exception(std::format_string< Args... > fmt, Args &&... args)
Format under StormByte.Buffer.
Definition exception.hxx:76
Exception(std::string message)
Format a plain message under StormByte.Buffer.
Definition exception.hxx:83
~Exception() noexcept override
Destructor.
Read, extract or peek failed.
Definition exception.hxx:145
~ReadError() noexcept override
Destructor.
ReadError(std::format_string< Args... > fmt, Args &&... args)
Format under StormByte.Buffer.Read.
Definition exception.hxx:154
ReadError(const StormByte::Safe::String &message)
Copies Base-owned text under StormByte.Buffer.Read.
Definition exception.hxx:168
ReadError(std::string message)
Format a plain message under StormByte.Buffer.Read.
Definition exception.hxx:161
Write failed.
Definition exception.hxx:181
WriteError(std::format_string< Args... > fmt, Args &&... args)
Format under StormByte.Buffer.Write.
Definition exception.hxx:190
~WriteError() noexcept override
Destructor.
WriteError(const StormByte::Safe::String &message)
Copies Base-owned text under StormByte.Buffer.Write.
Definition exception.hxx:204
WriteError(std::string message)
Format a plain message under StormByte.Buffer.Write.
Definition exception.hxx:197
Buffer module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_BUFFER_PUBLIC
Definition visibility.h:54