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 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * or later, as published by the Free Software Foundation.
 *
 * 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
 * along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 */
 
#pragma once
 
#include <StormByte/buffer/exception.hxx>
#include <StormByte/logger/log.hxx>
#include <StormByte/expected.hxx>
 
#include <cstddef>
#include <functional>
#include <memory>
#include <span>
#include <vector>
 
namespace StormByte::Buffer {
    class Consumer;     
    class Producer;     
    class ReadOnly;     
    class WriteOnly;    
 
    enum class STORMBYTE_BUFFER_PUBLIC Position {
        Absolute,   
        Relative    
    };
 
    using DataType = std::vector<std::byte>;
 
    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);
    }
}