ResultError.h¶

↰ Parent directory: omni/core/

Helpers related reporting errors from omni::core::Result.

Included By¶

omni/structuredlog/IStructuredLog.gen.h: This file was generated by omni.bind.
omni/structuredlog/IStructuredLogSettings.gen.h: This file was generated by omni.bind.
omni/structuredlog/IStructuredLogFromILog.gen.h: This file was generated by omni.bind.
omni/log/ILog.gen.h: This file was generated by omni.bind.
omni/log/ILogChannelFilter.gen.h: This file was generated by omni.bind.
omni/core/IObject.gen.h: This file was generated by omni.bind.
omni/experimental/job/IJob.gen.h: This file was generated by omni.bind.
omni/platforminfo/ICpuInfo.gen.h: This file was generated by omni.bind.
omni/platforminfo/IMemoryInfo.gen.h: This file was generated by omni.bind.
omni/platforminfo/IOsInfo.gen.h: This file was generated by omni.bind.
omni/str/IReadOnlyCString.gen.h: This file was generated by omni.bind.
omni/structuredlog/IStructuredLogControl.gen.h: This file was generated by omni.bind.

omni::core::ResultError: Exception object that encapsulates a omni::core::Result along with a customizable message.

omni::core::resultToString: Given a omni::core::Result code, returns a human readable interpretation of the code.

OMNI_CATCH_ABI_EXCEPTION: Helper macro to catch exceptions and return them as omni::core::Result codes. Useful when writing ABI code.
OMNI_RETURN_ERROR: Helper macro used to return a omni::core::Result. When in debug mode and attached to a debugger, this macro will cause a debugger break. Useful for determining the origin of an error.
OMNI_RETURN_IF_ARG_NULL: Helper macro to return an appropriate omni::core::Result when the given argument is nullptr. Useful when authoring ABI code.
OMNI_THROW_IF_ARG_NULL: Helper macro to throw a omni::core::ResultError exception if a function argument is nullptr. Used heavily by omni.bind.
OMNI_THROW_IF_FAILED: Helper macro to convert a omni::core::Result to a omni::core::ResultError exception. Useful when authoring API code. Used heavily by omni.bind.