Error.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_ERROR_ERROR_H
#define SQUID_SRC_ERROR_ERROR_H
 
#include "error/Detail.h"
#include "error/forward.h"
#include "mem/PoolingAllocator.h"
 
#include <iosfwd>
#include <vector>
 
using ErrorDetails = std::vector<ErrorDetailPointer, PoolingAllocator<ErrorDetailPointer> >;
 
std::ostream &operator <<(std::ostream &, const ErrorDetails &);
 
class Error {
public:
    Error() = default;
    Error(const err_type c): category(c) {} 
    Error(const err_type c, const ErrorDetailPointer &d): Error(c) { update(d); }
 
    explicit operator bool() const { return category != ERR_NONE; }
 
    void update(const Error &);
 
    void update(err_type, const ErrorDetailPointer &);
 
    void update(err_type);
 
    void update(const ErrorDetailPointer &detail);
 
    void clear() { *this = Error(); }
 
    err_type category = ERR_NONE; 
 
    ErrorDetails details;
};
 
extern const char *err_type_str[];
 
inline
err_type
errorTypeByName(const char *name)
{
    for (int i = 0; i < ERR_MAX; ++i)
        if (strcmp(name, err_type_str[i]) == 0)
            return (err_type)i;
    return ERR_MAX;
}
 
inline
const char *
errorTypeName(err_type err)
{
    if (err < ERR_NONE || err >= ERR_MAX)
        return "UNKNOWN";
    return err_type_str[err];
}
 
std::ostream &operator <<(std::ostream &os, const Error &error);
 
#endif /* SQUID_SRC_ERROR_ERROR_H */