typedefs.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/binary_data.hxx>
#include <StormByte/byte_size.hxx>
#include <StormByte/buffer/exception.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/expected.hxx>
 
#include <cstddef>
#include <functional>
#include <memory>
#include <span>
 
namespace StormByte::Buffer {
    class Consumer;     
    class Producer;     
    class ReadOnly;     
    class WriteOnly;    
 
    enum class STORMBYTE_BUFFER_PUBLIC Position {
        Absolute,   
        Relative    
    };
 
    enum class STORMBYTE_BUFFER_PUBLIC ExecutionMode : unsigned {
        Sync     = 0,           
        Async    = 1u << 0,     
        Parallel = 1u << 1      
    };
 
    inline constexpr ExecutionMode operator|(ExecutionMode a, ExecutionMode b) noexcept {
        return static_cast<ExecutionMode>(
            static_cast<unsigned>(a) | static_cast<unsigned>(b));
    }
 
    inline constexpr ExecutionMode operator&(ExecutionMode a, ExecutionMode b) noexcept {
        return static_cast<ExecutionMode>(
            static_cast<unsigned>(a) & static_cast<unsigned>(b));
    }
 
    inline constexpr ExecutionMode& operator|=(ExecutionMode& a, ExecutionMode b) noexcept {
        a = a | b;
        return a;
    }
 
    inline constexpr bool HasExecutionFlag(ExecutionMode mode, ExecutionMode flag) noexcept {
        return (static_cast<unsigned>(mode) & static_cast<unsigned>(flag)) ==
            static_cast<unsigned>(flag);
    }
}