CesiumUtility::Result< T > Struct Template Reference

Holds the result of an operation. If the operation succeeds, it will provide a value. It may also provide errors and warnings. More...

#include <CesiumUtility/Result.h>

Public Member Functions
	Result (T value_) noexcept
	Creates a Result with the given value and an empty ErrorList.
	Result (T value_, ErrorList errors_) noexcept
	Creates a Result with the given value and ErrorList.
	Result (ErrorList errors_) noexcept
	Creates a Result with an empty value and the given ErrorList.

Public Attributes
std::optional< T >	value
	The value, if the operation succeeded to the point where it can provide one.
ErrorList	errors
	The errors and warnings that occurred during the operation.

Detailed Description

template<typename T>
struct CesiumUtility::Result< T >

Holds the result of an operation. If the operation succeeds, it will provide a value. It may also provide errors and warnings.

Template Parameters

T	The type of value included in the result.

Definition at line 16 of file Result.h.

Constructor & Destructor Documentation

Result() [1/3]

template<typename T >

CesiumUtility::Result< T >::Result ( T value_ )

inlinenoexcept

Creates a Result with the given value and an empty ErrorList.

Parameters

value_

The value that will be contained in this Result.

Definition at line 22 of file Result.h.

Result() [2/3]

template<typename T >

CesiumUtility::Result< T >::Result ( T value_, ErrorList errors_ )

inlinenoexcept

Creates a Result with the given value and ErrorList.

Parameters

value_	The value that will be contained in this Result.
errors_	The ErrorList containing errors and warnings related to this Result.

Definition at line 31 of file Result.h.

Result() [3/3]

template<typename T >

CesiumUtility::Result< T >::Result ( ErrorList errors_ )

inlinenoexcept

Creates a Result with an empty value and the given ErrorList.

Parameters

errors_

The ErrorList containing errors and warnings related to this Result.

Definition at line 40 of file Result.h.

Member Data Documentation

errors

template<typename T >

ErrorList CesiumUtility::Result< T >::errors

The errors and warnings that occurred during the operation.

If a value is provided, there should not be any errors in this list, but there may be warnings. If a value is not provided, there should be at least one error in this list.

Definition at line 58 of file Result.h.

value

template<typename T >

std::optional<T> CesiumUtility::Result< T >::value

The value, if the operation succeeded to the point where it can provide one.

If a value is not provided because the operation failed, then there should be at least one error in errors indicating what went wrong.

Definition at line 49 of file Result.h.

---

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

• /home/runner/work/cesium-native/cesium-native/CesiumUtility/include/CesiumUtility/Result.h