§tiro::result

Refers to a result value.

#include "tiropp/objects.hpp"

Inherits from handle

§Public Functions

	Name
	result(handle h)
	result(const result & ) =default
	result(result && ) =default
result &	operator=(const result & ) =default
result &	operator=(result && ) =default
bool	is_success() const Returns true if this value represents success.
bool	is_error() const Returns true if this value represents an error.
handle	value() const Returns the value held by this result (which must represent success).
handle	error() const Returns the error held by this result (which must represent an error).

Protected Classes inherited from handle

	Name
struct	check_kind_t

Public Functions inherited from handle

	Name
template <typename T > T	as() const Converts this value to the target type.
template <typename T > T	as() Converts this value to the target type.
	handle(tiro_vm_t raw_vm) Constructs a new handle instance.
	handle(const handle & other) Constructs a new handle and initialize is it with the same value as `other`.
	handle(handle && other) =default Move constructs a handle.
	~handle() =default
bool	valid() const Returns true if this handle points to an object (i.e. it was not moved from).
value_kind	kind() const Returns the kind of the value currently held by this handle.
template <typename T > bool	is() const Returns true if this value is of the target type.
type	type_of() const Returns the type of the value currently held by this handle.
string	to_string() const Returns a string that represents the current value.
tiro_vm_t	raw_vm() const Returns the raw vm instance associated with this handle.
tiro_handle_t	raw_handle() const Returns the raw handle instance (nullptr for invalid handles).

Protected Functions inherited from handle

	Name
	handle(check_kind_t , handle && other, value_kind expected)

Protected Attributes inherited from handle

	Name
constexpr check_kind_t	check_kind

inline explicit result(
    handle h
)

result(
    const result & 
) =default

result(
    result && 
) =default

result & operator=(
    const result & 
) =default

result & operator=(
    result && 
) =default

inline bool is_success() const

Returns true if this value represents success.

inline bool is_error() const

Returns true if this value represents an error.

inline handle value() const

Returns the value held by this result (which must represent success).

inline handle error() const

Returns the error held by this result (which must represent an error).

Updated on 2022-02-27 at 21:17:13 +0100