StormByte-Logger 3.0.0
C++26 logger 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-Logger.
5 *
6 * StormByte-Logger 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-Logger 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-String tree and
23 * the StormByte Base tree it vendors), which remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Logger is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Logger. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
43#include <StormByte/exception.hxx>
45#include <StormByte/type_traits/safe.hxx>
46
47#include <string_view>
48#include <utility>
49
54namespace StormByte::Logger {
62 public:
67 struct Path {
68 std::string_view segments;
69
74 explicit constexpr Path(std::string_view segments) noexcept: segments(segments) {}
75 };
76
83 template <typename... Args>
84 requires (sizeof...(Args) >= 1)
85 Exception(std::string_view pattern, Args&&... args)
86 : StormByte::Exception(StormByte::Exception::Path{"Logger"}, pattern, std::forward<Args>(args)...) {}
87
92 explicit Exception(std::string_view message);
93
99 Exception(Path path, std::string_view message);
100
108 template <typename... Args>
109 requires (sizeof...(Args) >= 1)
110 Exception(Path path, std::string_view pattern, Args&&... args)
111 : Exception(path, static_cast<std::string_view>(StormByte::Safe::String::ReplaceToken(pattern, std::forward<Args>(args)...))) {}
112
117 Exception(const Exception& other) = default;
118
123 Exception(Exception&& other) noexcept = default;
124
128 ~Exception() noexcept override;
129
135 Exception& operator=(const Exception& other) = default;
136
142 Exception& operator=(Exception&& other) noexcept = default;
143 };
144
150 public:
152
156 ~ThrottleError() noexcept override;
157 };
158}
159
Exception(Path path, std::string_view message)
Plain message under an additional Logger path.
Exception(Exception &&other) noexcept=default
Move constructor.
Exception(const Exception &other)=default
Copy constructor.
~Exception() noexcept override
Destructor.
Exception(Path path, std::string_view pattern, Args &&... args)
Replace literal {} under an additional Logger path.
Definition exception.hxx:110
Exception(std::string_view message)
Copy a plain message under StormByte.Logger.
Exception(std::string_view pattern, Args &&... args)
Replace literal {} under StormByte.Logger.
Definition exception.hxx:85
Thrown when a throttle rule is invalid.
Definition exception.hxx:149
~ThrottleError() noexcept override
Destructor.
Exception(std::string_view pattern, Args &&... args)
Replace literal {} under StormByte.Logger.
Definition exception.hxx:85
static String ReplaceToken(std::string_view text, Args &&... args)
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Logger::Exception)
Logger module of the StormByte suite.
Additional path segments nested below StormByte.Logger.
Definition exception.hxx:67
std::string_view segments
Additional dotted path segments.
Definition exception.hxx:68
constexpr Path(std::string_view segments) noexcept
Wraps additional path segments.
Definition exception.hxx:74
#define STORMBYTE_LOGGER_PUBLIC
Definition visibility.h:53