SerialPortError.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Common/Result.h"
 
namespace SC
{
 
enum class SerialPortError : uint32_t
{
    InvalidBaudRate = 1,
    InvalidDataBits,
    InvalidParity,
    InvalidStopBits,
    InvalidFlowControl,
    InvalidHandle,
    UnsupportedPathEncoding,
    InvalidPath,
    PathMustBeAbsolute,
    OpenFailed,
    ReadSettingsFailed,
    SetSettingsFailed,
    UnsupportedHardwareFlowControl,
    UnsupportedBaudRate,
    UnsupportedDataBits,
    UnsupportedParity,
    UnsupportedStopBits,
    PathTooLong,
};
 
enum class SerialPortErrorDetail : uint32_t
{
    None = 0,
    PosixOpen,
    PosixReadDescriptorFlags,
    PosixSetDescriptorFlags,
    PosixReadSettings,
    PosixSetInputBaudRate,
    PosixSetOutputBaudRate,
    PosixSetSettings,
    WindowsCreateFile,
    WindowsSetTimeouts,
    WindowsReadSettings,
    WindowsSetSettings,
};
 
static constexpr ResultCategory SerialPortResultCategory = ResultCategory(3);
 
struct [[nodiscard]] ResultSerialPort
{
    Result                result;
    SerialPortErrorDetail detail      = SerialPortErrorDetail::None;
    uint32_t              nativeError = 0;
 
    explicit constexpr ResultSerialPort(bool valid = true) : result(valid) {}
    constexpr ResultSerialPort(SerialPortError error, SerialPortErrorDetail detail = SerialPortErrorDetail::None,
                               uint32_t nativeError = 0)
        : result(Result::Error(SerialPortResultCategory, error)), detail(detail), nativeError(nativeError)
    {}
    constexpr ResultSerialPort(Result result) : result(result) {}
 
    template <typename ResultLike>
    constexpr ResultSerialPort(const ResultLike& other) : result(other.toResult())
    {}
 
    explicit constexpr operator bool() const { return static_cast<bool>(result); }
 
    constexpr operator Result() const { return result; }
 
    constexpr Result toResult() const { return result; }
    constexpr bool   isError(SerialPortError error) const { return result.isError(SerialPortResultCategory, error); }
};
 
} // namespace SC