exception.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Buffer.
 *
 * StormByte-Buffer original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Buffer source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-Logger tree and
 * the rest of the StormByte suite it vendors), which remains under its own
 * license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Buffer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/buffer/visibility.h>
#include <StormByte/exception.hxx>
 
#include <format>
#include <string>
#include <utility>
 
namespace StormByte::Buffer {
    class STORMBYTE_BUFFER_PUBLIC Exception: public StormByte::Exception {
        public:
            template <typename... Args>
            explicit Exception(std::format_string<Args...> fmt, Args&&... args)
                : StormByte::Exception(StormByte::Exception::Path{"Buffer"}, fmt, std::forward<Args>(args)...) {}
 
            explicit Exception(std::string message)
                : Exception("{}", std::move(message)) {}
 
            ~Exception() noexcept override;
 
        protected:
            template <typename... Args>
            explicit Exception(StormByte::Exception::Path child, std::format_string<Args...> fmt, Args&&... args)
                : StormByte::Exception(
                    StormByte::Exception::Path{std::string("Buffer.") + std::string(child.text)},
                    fmt,
                    std::forward<Args>(args)...) {}
    };
 
    class STORMBYTE_BUFFER_PUBLIC Error: public Exception {
        public:
            using Exception::Exception;
 
            ~Error() noexcept override;
    };
 
    class STORMBYTE_BUFFER_PUBLIC ReadError: public Error {
        public:
            template <typename... Args>
            explicit ReadError(std::format_string<Args...> fmt, Args&&... args)
                : Error(StormByte::Exception::Path{"Read"}, fmt, std::forward<Args>(args)...) {}
 
            explicit ReadError(std::string message)
                : ReadError("{}", std::move(message)) {}
 
            ~ReadError() noexcept override;
    };
 
    class STORMBYTE_BUFFER_PUBLIC WriteError: public Error {
        public:
            template <typename... Args>
            explicit WriteError(std::format_string<Args...> fmt, Args&&... args)
                : Error(StormByte::Exception::Path{"Write"}, fmt, std::forward<Args>(args)...) {}
 
            explicit WriteError(std::string message)
                : WriteError("{}", std::move(message)) {}
 
            ~WriteError() noexcept override;
    };
}