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/buffer/visibility.h>
#include <StormByte/byte_size.hxx>
 
#include <string_view>
 
namespace StormByte {
    namespace Buffer {
        namespace IO {
            enum class STORMBYTE_BUFFER_PUBLIC Status {
                Ok,         
                End,        
                Error,      
                Failed,     
                TryAgain    
            };
 
            enum class STORMBYTE_BUFFER_PUBLIC State {
                Idle,           
                Missing,        
                Directory,      
                Permission,     
                NotWritable,    
                Fault,          
                Unavailable     
            };
 
            [[nodiscard]] constexpr std::string_view ToString(Status status) noexcept {
                switch (status) {
                    case Status::Ok:        return "Ok";
                    case Status::End:       return "End";
                    case Status::Error:     return "Error";
                    case Status::Failed:    return "Failed";
                    case Status::TryAgain:  return "TryAgain";
                }
                return {};
            }
 
            [[nodiscard]] constexpr std::string_view ToString(State state) noexcept {
                switch (state) {
                    case State::Idle:           return "Idle";
                    case State::Missing:        return "Missing";
                    case State::Directory:      return "Directory";
                    case State::Permission:     return "Permission";
                    case State::NotWritable:    return "NotWritable";
                    case State::Fault:          return "Fault";
                    case State::Unavailable:    return "Unavailable";
                }
                return {};
            }
 
            enum class STORMBYTE_BUFFER_PUBLIC Location {
                Local,  
                Remote  
            };
 
            [[nodiscard]] constexpr std::string_view ToString(Location location) noexcept {
                switch (location) {
                    case Location::Local:   return "Local";
                    case Location::Remote:  return "Remote";
                }
                return {};
            }
 
            struct STORMBYTE_BUFFER_PUBLIC Result {
                Status status;                  
                StormByte::ByteSize count;          
            };
 
            namespace Drainer {
                enum class STORMBYTE_BUFFER_PUBLIC Status {
                    Started,    
                    Paused,     
                    Stopped     
                };
 
                enum class STORMBYTE_BUFFER_PUBLIC Operation {
                    Toggle,     
                    Flush       
                };
 
                [[nodiscard]] constexpr std::string_view ToString(Status status) noexcept {
                    switch (status) {
                        case Status::Started:   return "Started";
                        case Status::Paused:    return "Paused";
                        case Status::Stopped:   return "Stopped";
                    }
                    return {};
                }
 
                [[nodiscard]] constexpr std::string_view ToString(Operation operation) noexcept {
                    switch (operation) {
                        case Operation::Toggle: return "Toggle";
                        case Operation::Flush:  return "Flush";
                    }
                    return {};
                }
            }
        }
    }
}