result_info_decl.h File Reference

#include <a_util/preprocessor/deprecated.h>
#include <cstdint>
#include <limits>

Include dependency graph for result_info_decl.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	a_util::result::ResultInfo< T >
struct	a_util::result::ResultInfo< void >

Namespaces
namespace	a_util
	Serves as the root component, with common functionality documented in core functionality.
namespace	a_util::result
	Serves as component for functionality handling error and return types.

Macros
#define	_MAKE_RESULT(_no, _label)

Functions
template<typename ResultType>
bool	a_util::result::isOk (const ResultType &result)
template<typename ResultType>
bool	a_util::result::isFailed (const ResultType &result)
template<typename ResultTypeLHS, typename ResultTypeRHS>
bool	a_util::result::operator== (const ResultInfo< ResultTypeLHS > &lhs, const ResultInfo< ResultTypeRHS > &rhs)
template<typename ResultTypeLHS, typename ResultTypeRHS>
bool	a_util::result::operator!= (const ResultInfo< ResultTypeLHS > &lhs, const ResultInfo< ResultTypeRHS > &rhs)
template<typename ResultTypeLHS, typename ResultTypeRHS>
bool	a_util::result::operator< (const ResultInfo< ResultTypeLHS > &lhs, const ResultInfo< ResultTypeRHS > &rhs)
template<typename ResultTypeLHS, typename ResultTypeRHS>
bool	a_util::result::operator> (const ResultInfo< ResultTypeLHS > &lhs, const ResultInfo< ResultTypeRHS > &rhs)
template<typename ResultTypeLHS, typename ResultTypeRHS>
bool	a_util::result::operator<= (const ResultInfo< ResultTypeLHS > &lhs, const ResultInfo< ResultTypeRHS > &rhs)
template<typename ResultTypeLHS, typename ResultTypeRHS>
bool	a_util::result::operator>= (const ResultInfo< ResultTypeLHS > &lhs, const ResultInfo< ResultTypeRHS > &rhs)

Detailed Description

Public API for ResultInfo type, functions and macros

Copyright

Copyright 2025 Digitalwerk GmbH.

This Source Code Form is subject to the terms of the Mozilla
Public License, v. 2.0. If a copy of the MPL was not distributed
with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

Macro Definition Documentation

_MAKE_RESULT

#define _MAKE_RESULT	(		_no,
			_label )

Value:

    namespace {                                                                                    \
    struct ResultType_##_label : public ::a_util::result::ResultInfo<ResultType_##_label> {        \
        static std::int32_t getCode()                                                              \
        {                                                                                          \
            static_assert(std::is_same<decltype((_no)), std::int32_t>::value,                      \
                          #_no " is not in range of std::int32_t.");                               \
            return _no;                                                                            \
        }                                                                                          \
        static const char* getLabel()                                                              \
        {                                                                                          \
            return #_label;                                                                        \
        }                                                                                          \
    };                                                                                             \
    const ::a_util::result::ResultInfo<ResultType_##_label> _label = ResultType_##_label();        \
    } /* ns anonymous */                                                                           \
    static_assert(DEV_ESSENTIAL_INTERNAL_MAKE_RESULT_CHECK_NOT_ZERO(_no),                          \
                  "'0' is not allowed, because it is reserved for results indicating no error. "   \
                  "Please use a_util::result::SUCCESS instead. To disable this check, define "     \
                  "'DEV_ESSENTIAL_DISABLE_MAKE_RESULT_CHECK_RESERVED_ZERO'")

Create a result type and a constant instance of this type in an unnamed namespace

Parameters

[in]	_no	Numeric representation of the result type
[in]	_label	Stringified version for the result type