device.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-System.
 *
 * StormByte-System 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-System 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 Base tree), 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-System 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-System. 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/bitmask.hxx>
#include <StormByte/error.hxx>
#include <StormByte/size.hxx>
#include <StormByte/string/string.hxx>
#include <StormByte/system/visibility.h>
 
#include <cstdint>
#include <filesystem>
#include <string>
#include <string_view>
#include <system_error>
 
namespace StormByte::System {
    class STORMBYTE_SYSTEM_PUBLIC Device {
        public:
            enum class Error {
                Success = 0,        
                BrokenSymlink,      
                DeviceNotFound,     
                NotADevice,         
                Permission,         
                ProbeFailed         
            };
 
            enum class Kind {
                HDD,        
                SSD,        
                NVMeGen3,   
                NVMeGen4,   
                NVMeGen5,   
                USBHDD,     
                USBStick,   
                Network     
            };
 
            enum class AccessFlag: std::uint8_t {
                Readable = 0x01,    
                Writable = 0x02     
            };
 
            class STORMBYTE_SYSTEM_PUBLIC Access: public StormByte::Bitmask<Access, AccessFlag> {
                public:
                    using Bitmask::Bitmask;
            };
 
            struct Throughput {
                std::size_t read_bps;   
                std::size_t write_bps;  
            };
 
            struct Window {
                StormByte::Size read;   
                StormByte::Size write;  
            };
 
            explicit Device(const StormByte::String::String& path) noexcept;
 
            explicit Device(std::string_view path) noexcept;
 
            explicit Device(std::wstring_view path) noexcept;
 
            explicit Device(const std::filesystem::path& path) noexcept;
 
            Device(const Device&) = default;
 
            Device(Device&&) noexcept = default;
 
            Device& operator=(const Device&) = default;
 
            Device& operator=(Device&&) noexcept = default;
 
            virtual ~Device() = default;
 
            explicit operator bool() const noexcept;
 
            StormByte::Error::Fault Fault() const noexcept;
 
            const StormByte::String::String& Path() const noexcept;
 
            enum Kind Kind() const noexcept;
 
            class Access Access() const noexcept;
 
            virtual struct Throughput Throughput() const noexcept;
 
            virtual struct Window Window() const noexcept;
 
        private:
            StormByte::String::String m_path;   
    };
}
 
template<>
struct StormByte::Error::Domain<StormByte::System::Device::Error> {
    static constexpr const char* Name = "StormByte.System.Device";  
 
    static std::string Message(StormByte::System::Device::Error e) {
        switch (e) {
            case StormByte::System::Device::Error::Success:
                return "Success";
            case StormByte::System::Device::Error::BrokenSymlink:
                return "Broken symbolic link";
            case StormByte::System::Device::Error::DeviceNotFound:
                return "Device not found";
            case StormByte::System::Device::Error::NotADevice:
                return "Path is not a classifiable device";
            case StormByte::System::Device::Error::Permission:
                return "Device permission denied";
            case StormByte::System::Device::Error::ProbeFailed:
                return "Device probe failed";
        }
        return "Unknown Device error";
    }
};
 
namespace StormByte::System {
    STORMBYTE_SYSTEM_PUBLIC const StormByte::Error::Category<Device::Error>& device_category() noexcept;
 
    STORMBYTE_SYSTEM_PUBLIC std::error_code make_error_code(Device::Error e) noexcept;
}
 
namespace std {
    template<>
    struct is_error_code_enum<StormByte::System::Device::Error>: true_type {};
}