Result Codes#

Returns true if the given omni::core::Result is a failure code.

If the given omni::core::Result is a failure code, calls return result to exit the current function.

Returns true if the given omni::core::Result is not a failure code.

Error code for the result of an operation.

Access has been denied for this operation.

Object already exists.

The operation failed.

Insufficient buffer.

An operation was interrupted. An "interruption" happens in cases where the operation did not complete successfully due to an outside system (such as a timer) interrupting it. For example, a function Result wait_for(duration d) might give kResultSuccess when function returns because the duration expired and kResultInterrupted if the system is shutting down.

One or more of the arguments passed to a given function was invalid.

Invalid data size. This arises when the correct type of data is requested, but the requester believes the data size is different from the receiver. The cause of this is typically a version mismatch.

Invalid data type. This is used in cases where a specific type of data is requested, but that is not the data which the receiver has.

Invalid index.

The operation was not valid for the target. For example, attempting to perform a write operation on a read-only file would result in this error.

The system is in an invalid state to perform the operation. This is distinct from kResultInvalidOperation in that it covers situations like "system is not yet started" or "file is closed.".

Interface not implemented.

No more items to return. This is meant for things like reader queues when they have run out of data and will never have more data. For cases where something like an async queue being temporarily empty, use kResultTryAgain .

Not enough data.

The item was not found.

The feature or method was not implemented. It might be at some point in the future.

The operation is not supported.

Pointer is null.

The operation was aborted.

A system is out of memory. This does not necessarily mean resident memory has been exhausted (although it can), as this code can be used to special conditions such as exhausting graphics memory or running out of a specific memory pool. It can also indicate that an allocation would have been too big and failed ahead of time.

Operation successful. No error occurred.

Timed out.

Too much data.

Try the operation again. This is typically emitted in situations where an operation would require blocking, but the system is configured to be non-blocking. For example, attempting to read from a TCP socket when no data has been received would return kResultTryAgain .

Version check failure.

Failed to parse the version.

Would block.