EntropyEngine::Networking::Result< void >
EntropyEngine::Networking::Result< void >
Section titled “EntropyEngine::Networking::Result< void >”Result specialization for void operations.
#include <ErrorCodes.h>
Public Functions
Section titled “Public Functions”| Name | |
|---|---|
| void & | [valueOrThrow](/api/EntropyEngine/Networking/Result< void >/#function-valueorthrow)() Get the value or throw on error. |
| void | [throwOnError](/api/EntropyEngine/Networking/Result< void >/#function-throwonerror)() const |
| bool | [success](/api/EntropyEngine/Networking/Result< void >/#function-success)() const |
| bool | [success](/api/EntropyEngine/Networking/Result< void >/#function-success)() const Check if operation succeeded. |
| Result< void > | [ok](/api/EntropyEngine/Networking/Result< void >/#function-ok)() |
| Result< void > | [ok](/api/EntropyEngine/Networking/Result< void >/#function-ok)(void val) Create a successful result. |
| bool | [failed](/api/EntropyEngine/Networking/Result< void >/#function-failed)() const |
| bool | [failed](/api/EntropyEngine/Networking/Result< void >/#function-failed)() const Check if operation failed. |
| Result< void > | [err](/api/EntropyEngine/Networking/Result< void >/#function-err)(NetworkError err, std::string message ="") |
| Result< void > | [err](/api/EntropyEngine/Networking/Result< void >/#function-err)(NetworkError err, std::string message ="") Create a failed result. |
Public Attributes
Section titled “Public Attributes”| Name | |
|---|---|
| void | [value](/api/EntropyEngine/Networking/Result< void >/#variable-value) Result value (valid only if error == None). |
| std::string | [errorMessage](/api/EntropyEngine/Networking/Result< void >/#variable-errormessage) |
| std::string | [errorMessage](/api/EntropyEngine/Networking/Result< void >/#variable-errormessage) Optional detailed error message. |
| NetworkError | [error](/api/EntropyEngine/Networking/Result< void >/#variable-error) |
| NetworkError | [error](/api/EntropyEngine/Networking/Result< void >/#variable-error) Error code. |
Public Functions Documentation
Section titled “Public Functions Documentation”function valueOrThrow
Section titled “function valueOrThrow”inline void & valueOrThrow()Get the value or throw on error.
Exceptions:
- std::runtime_error if operation failed
Return: The contained value
function throwOnError
Section titled “function throwOnError”inline void throwOnError() constfunction success
Section titled “function success”inline bool success() constfunction success
Section titled “function success”inline bool success() constCheck if operation succeeded.
Return: true if no error occurred
function ok
Section titled “function ok”static inline Result< void > ok()function ok
Section titled “function ok”static inline Result< void > ok( void val)Create a successful result.
Parameters:
- val The result value
Return: Result with no error
function failed
Section titled “function failed”inline bool failed() constfunction failed
Section titled “function failed”inline bool failed() constCheck if operation failed.
Return: true if an error occurred
function err
Section titled “function err”static inline Result< void > err( NetworkError err, std::string message ="")function err
Section titled “function err”static inline Result< void > err( NetworkError err, std::string message ="")Create a failed result.
Parameters:
- err The error code
- message Optional error message
Return: Result with error
Public Attributes Documentation
Section titled “Public Attributes Documentation”variable value
Section titled “variable value”void value;Result value (valid only if error == None).
variable errorMessage
Section titled “variable errorMessage”std::string errorMessage;variable errorMessage
Section titled “variable errorMessage”std::string errorMessage;Optional detailed error message.
variable error
Section titled “variable error”NetworkError error;variable error
Section titled “variable error”NetworkError error;Error code.
Updated on 2026-01-26 at 17:14:35 -0500