result_description_traits< DescriptionType >

Traits type for the result description. More...

Public Types
using	description_type = DescriptionType
	The description type.
using	reference_counted_object_type = ireference_counted_object< DescriptionType >

Static Public Member Functions
static tBool	is_detailed_description_set (const std::uint64_t i_pDescription) noexcept
	Check whether the detailed description was allocated. More...
static tBool	is_error_code_set (const std::uint64_t i_pDescription) noexcept
	Check whether only the error code was set. More...

Static Public Attributes
static constexpr std::uint64_t	error_code_bit = (std::uint64_t)1 << 63
	The error code bit indicating whether only the error code (1) was set or not (0)
static constexpr std::uint64_t	error_code_bitmask = ~error_code_bit
	The error code bitmask to mask out the error code bit.

Detailed Description

template<typename DescriptionType>
struct A_UTILS_NS::detail::result_description_traits< DescriptionType >

Traits type for the result description.

Template Parameters

DescriptionType

The detailed description type which might be used to allocate space for detailed error information

Definition at line 25 of file result_description.h.

Member Function Documentation

is_detailed_description_set()

static tBool is_detailed_description_set ( const std::uint64_t  i_pDescription )

inlinestaticnoexcept

Check whether the detailed description was allocated.

Parameters

[in]

i_pDescription

Pointer to the detailed description that is checked for the error code bit.

Returns

tTrue if detailed description was allocated (the error code bit is not set), tFalse otherwise

Definition at line 42 of file result_description.h.

References result_description_traits< DescriptionType >::error_code_bit, and result_description_traits< DescriptionType >::error_code_bitmask.

Referenced by result_description< DescriptionType >::get_detailed_description().

is_error_code_set()

static tBool is_error_code_set ( const std::uint64_t  i_pDescription )

inlinestaticnoexcept

Check whether only the error code was set.

Parameters

[in]

i_pDescription

Pointer to the description type that is checked for the error code bit.

Returns

tTrue if only the error code was set (the error code bit is set), tFalse otherwise

Definition at line 55 of file result_description.h.

References result_description_traits< DescriptionType >::error_code_bit.

Referenced by result_description< DescriptionType >::get_error_code().