expect.h File Reference

#include <cassert>
#include <system_error>
#include <type_traits>
#include <utility>
#include "common/error.h"

Include dependency graph for expect.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	detail::expect
class	expect< T >
class	expect< void >

Namespaces
namespace	detail
	declaration and default definition for the functions used the API

Macros
#define	ELECTRONEUM_PRECOND(...)
	If precondition fails, return ::error::kInvalidArgument in current scope.
#define	ELECTRONEUM_CHECK(...)
	Check expect<void> and return errors in current scope.
#define	ELECTRONEUM_UNWRAP(...)
#define	ELECTRONEUM_THROW(code, msg)

Typedefs
template<bool C>
using	detail::enable_if = typename std::enable_if<C>::type

Functions
*return An expect< void > object with	!has_error ()`. inline expect< void > success() noexcept
template<typename T, typename U>
bool	operator== (expect< T > const &lhs, expect< U > const &rhs) noexcept(noexcept(lhs.equal(rhs)))
template<typename T, typename U>
bool	operator== (expect< T > const &lhs, U const &rhs) noexcept(noexcept(lhs.equal(rhs)))
template<typename T, typename U>
bool	operator== (T const &lhs, expect< U > const &rhs) noexcept(noexcept(rhs.equal(lhs)))
template<typename T, typename U>
bool	operator!= (expect< T > const &lhs, expect< U > const &rhs) noexcept(noexcept(lhs.equal(rhs)))
template<typename T, typename U>
bool	operator!= (expect< T > const &lhs, U const &rhs) noexcept(noexcept(lhs.equal(rhs)))
template<typename T, typename U>
bool	operator!= (T const &lhs, expect< U > const &rhs) noexcept(noexcept(rhs.equal(lhs)))

Macro Definition Documentation

ELECTRONEUM_CHECK

#define ELECTRONEUM_CHECK

(

...

)

Value:

do                                              \
{                                               \
    const ::expect<void> result = __VA_ARGS__ ; \
    if (!result)                                \
        return result.error();                  \
} while (0)

Check expect<void> and return errors in current scope.

Definition at line 47 of file expect.h.

#define ELECTRONEUM_CHECK(...)                           \
    do                                              \
    {                                               \
        const ::expect<void> result = __VA_ARGS__ ; \
        if (!result)                                \
            return result.error();                  \
    } while (0)

ELECTRONEUM_PRECOND

#define ELECTRONEUM_PRECOND

(

...

)

Value:

do                                                 \
{                                                  \
    if (!( __VA_ARGS__ ))                          \
        return {::common_error::kInvalidArgument}; \
} while (0)

If precondition fails, return ::error::kInvalidArgument in current scope.

Definition at line 39 of file expect.h.

#define ELECTRONEUM_PRECOND(...)                            \
    do                                                 \
    {                                                  \
        if (!( __VA_ARGS__ ))                          \
            return {::common_error::kInvalidArgument}; \
    } while (0)

ELECTRONEUM_THROW

#define ELECTRONEUM_THROW	(		code,
			msg )

Value:

::detail::expect::throw_( code , msg , __FILE__ , __LINE__ )

Definition at line 66 of file expect.h.

#define ELECTRONEUM_THROW(code, msg) \
    ::detail::expect::throw_( code , msg , __FILE__ , __LINE__ )

ELECTRONEUM_UNWRAP

#define ELECTRONEUM_UNWRAP

(

...

)

Value:

::detail::expect::unwrap( __VA_ARGS__ , nullptr, __FILE__ , __LINE__ )

Get T from expect<T> by std::move as-if by function call. expect<void> returns nothing.

Exceptions

std::system_error

with expect<T>::error(), filename and line number when expect<T>::has_error() == true.

Definition at line 60 of file expect.h.

#define ELECTRONEUM_UNWRAP(...)                                        \
    ::detail::expect::unwrap( __VA_ARGS__ , nullptr, __FILE__ , __LINE__ )

Function Documentation

!has_error()

*return An expect< void > object with !has_error ( )

noexcept

Definition at line 396 of file expect.h.

                                       { return expect<void>{}; }

operator!=() [1/3]

template<typename T, typename U>

bool operator!= ( expect< T > const & lhs, expect< U > const & rhs )

inlinenoexcept

Definition at line 422 of file expect.h.

{
    return !lhs.equal(rhs);
}

operator!=() [2/3]

template<typename T, typename U>

bool operator!= ( expect< T > const & lhs, U const & rhs )

inlinenoexcept

Definition at line 429 of file expect.h.

{
    return !lhs.equal(rhs);
}

operator!=() [3/3]

template<typename T, typename U>

bool operator!= ( T const & lhs, expect< U > const & rhs )

inlinenoexcept

Definition at line 436 of file expect.h.

{
    return !rhs.equal(lhs);
}

operator==() [1/3]

template<typename T, typename U>

bool operator== ( expect< T > const & lhs, expect< U > const & rhs )

inlinenoexcept

Definition at line 401 of file expect.h.

{
    return lhs.equal(rhs);
}

Here is the caller graph for this function:

operator==() [2/3]

template<typename T, typename U>

bool operator== ( expect< T > const & lhs, U const & rhs )

inlinenoexcept

Definition at line 408 of file expect.h.

{
    return lhs.equal(rhs);
}

operator==() [3/3]

template<typename T, typename U>

bool operator== ( T const & lhs, expect< U > const & rhs )

inlinenoexcept

Definition at line 415 of file expect.h.

{
    return rhs.equal(lhs);
}