duvc::Result< void > Class Reference

Specialization for void results (operations that don't return values) More...

#include <duvc-ctl/core/result.h>

Collaboration diagram for duvc::Result< void >:

Public Member Functions
	Result ()
	Create successful void result.
	Result (Error error)
	Create error result.
	Result (ErrorCode code, std::string message="")
	Create error result from error code.
bool	is_ok () const
	Check if result is success.
bool	is_error () const
	Check if result is error.
const Error &	error () const
	Get the error (assumes error)
	operator bool () const
	Boolean conversion (true if success)

Detailed Description

Specialization for void results (operations that don't return values)

Definition at line 160 of file result.h.

Constructor & Destructor Documentation

Result() [1/3]

duvc::Result< void >::Result ( )

inline

Create successful void result.

Definition at line 165 of file result.h.

Result() [2/3]

duvc::Result< void >::Result ( Error error )

inline

Create error result.

Parameters

error

Error information

Definition at line 171 of file result.h.

Result() [3/3]

duvc::Result< void >::Result ( ErrorCode code, std::string message = "" )

inline

Create error result from error code.

Parameters

code	Error code
message	Optional error message

Definition at line 178 of file result.h.

Member Function Documentation

error()

const Error & duvc::Result< void >::error ( ) const

inline

Get the error (assumes error)

Returns

Reference to error

Definition at line 197 of file result.h.

is_error()

bool duvc::Result< void >::is_error ( ) const

inline

Check if result is error.

Returns

true if error

Definition at line 191 of file result.h.

is_ok()

bool duvc::Result< void >::is_ok ( ) const

inline

Check if result is success.

Returns

true if successful

Definition at line 185 of file result.h.

operator bool()

duvc::Result< void >::operator bool ( ) const

inlineexplicit

Boolean conversion (true if success)

Definition at line 202 of file result.h.

References duvc::Result< T >::is_ok().

Here is the call graph for this function:

---

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

• core/result.h