tec_status.hpp

Go to the documentation of this file.

// Time-stamp: <Last changed 2026-02-20 16:03:55 by magnolia>
/*----------------------------------------------------------------------
------------------------------------------------------------------------
Copyright (c) 2020-2026 The Emacs Cat (https://github.com/olddeuteronomy/tec).
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
------------------------------------------------------------------------
----------------------------------------------------------------------*/
#pragma once
 
#include <iostream>
#include <optional>
#include <ostream>
#include <sstream>
#include <string>
 
#include "tec/tec_def.hpp" // IWYU pragma: keep
 
 
namespace tec {
 
struct Error {
    enum class Kind : int {
        Ok,          
        Err,         
        IOErr,       
        RuntimeErr,  
        NetErr,      
        RpcErr,      
        TimeoutErr,  
        Invalid,     
        System,      
        NotImplemented, 
        Unsupported  
    };
 
    template <typename TCode = int>
    struct Code {
        constexpr static const TCode Unspecified{-1}; 
    };
};
 
inline constexpr const char* kind_as_string(Error::Kind k) {
    switch (k) {
    case Error::Kind::Ok: return "Success";
    case Error::Kind::Err: return "Generic";
    case Error::Kind::IOErr: return "IO";
    case Error::Kind::RuntimeErr: return "Runtime";
    case Error::Kind::NetErr: return "Network";
    case Error::Kind::RpcErr: return "Rpc";
    case Error::Kind::TimeoutErr: return "Timeout";
    case Error::Kind::Invalid: return "Invalid";
    case Error::Kind::System: return "System";
    case Error::Kind::NotImplemented: return "NotImplemented";
    case Error::Kind::Unsupported: return "Unsupported";
    default: return "Unspecified";
    }
}
 
template <typename TCode, typename TDesc>
struct TStatus {
    Error::Kind kind;          
    std::optional<TCode> code; 
    std::optional<TDesc> desc; 
 
    constexpr bool ok() const { return kind == Error::Kind::Ok; }
 
    constexpr operator bool() const { return ok(); }
 
    friend std::ostream& operator<<(std::ostream& out, const TStatus& status) {
        out << "[" << kind_as_string(status.kind) << "]";
        if (!status.ok()) {
            out << " Code=" << status.code.value_or(Error::Code<TCode>::Unspecified)
                << " Desc=\"" << (status.desc.has_value() ? status.desc.value() : "") << "\"";
        }
        return out;
    }
 
    std::string as_string() {
        std::ostringstream buf;
        buf << *this;
        return buf.str();
    }
 
    TStatus()
        : kind{Error::Kind::Ok}
    {}
 
    TStatus(Error::Kind _kind)
        : kind{_kind}
        , code{Error::Code<TCode>::Unspecified}
    {}
 
    TStatus(const TDesc& _desc, Error::Kind _kind = Error::Kind::Err)
        : kind{_kind}
        , code{Error::Code<TCode>::Unspecified}
        , desc{_desc}
    {}
 
    TStatus(const TCode& _code, Error::Kind _kind = Error::Kind::Err)
        : kind{_kind}
        , code{_code}
    {}
 
    TStatus(const TCode& _code, const TDesc& _desc, Error::Kind _kind = Error::Kind::Err)
        : kind{_kind}
        , code{_code}
        , desc{_desc}
    {}
}; // struct TStatus
 
using Status = TStatus<int, std::string>;
 
} // namespace tec