Encapsulates a result state (success or failure), with [[nodiscard]] enforcement. More...

#include <Types.h>

Public Member Functions
Constructors and Assignments
XII_ALWAYS_INLINE	xiiResult (xiiResultEnum result)
	Constructs a result from an enum value.

XII_ALWAYS_INLINE void	operator= (xiiResultEnum rhs)
	Assigns a new result state.

XII_ALWAYS_INLINE bool	operator== (xiiResultEnum cmp) const
	Compares the result to another enum value.

Status Queries
XII_ALWAYS_INLINE bool	Succeeded () const
	Returns true if the result indicates success.

XII_ALWAYS_INLINE bool	Failed () const
	Returns true if the result indicates failure.

Control and Assertions
XII_ALWAYS_INLINE void	IgnoreResult ()
	Suppresses compiler warnings when intentionally ignoring the result.

void	AssertSuccess (const char szMsg=nullptr, const char szDetails=nullptr) const
	Asserts that the result indicates success.

Detailed Description

Encapsulates a result state (success or failure), with [[nodiscard]] enforcement.

Provides clearer semantics than using raw booleans and encourages consistent status checking in functions and APIs. Also includes convenience utilities for asserting or ignoring result values.

Constructor & Destructor Documentation

◆ xiiResult()

XII_ALWAYS_INLINE xiiResult::xiiResult ( xiiResultEnum result )

inline

Constructs a result from an enum value.

Example:

xiiResult result = XII_SUCCESS;

xiiResult::xiiResult

XII_ALWAYS_INLINE xiiResult(xiiResultEnum result)

Constructs a result from an enum value.

Definition Types.h:74

Member Function Documentation

◆ AssertSuccess()

void xiiResult::AssertSuccess	(	const char *	szMsg = nullptr,
		const char *	szDetails = nullptr ) const

Asserts that the result indicates success.

If the result is failure, the program terminates.

Parameters

szMsg	Optional short message for assertion failure.
szDetails	Optional detailed message, used in conjunction with szMsg. If szDetails is provided, szMsg should contain a formatting placeholder (`{}`).

◆ IgnoreResult()

XII_ALWAYS_INLINE void xiiResult::IgnoreResult ( )

inline

Suppresses compiler warnings when intentionally ignoring the result.

To be used when result checking isn't necessary, e.g., in best-effort cleanup code.

The documentation for this struct was generated from the following files: