MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue > クラステンプレート

エラーをラップするテンプレートクラス [詳解]

#include <mgl_result_wrapper.h>

公開メンバ関数
constexpr	ResultWrapper (ErrorType error) noexcept
	エラー設定用コンストラクタ
constexpr	ResultWrapper () noexcept
	コンストラクタ
constexpr ErrorType	GetError () const noexcept
	エラーを取得
constexpr std::underlying_type_t< ErrorType >	GetErrorCode () const noexcept
	エラーコードを取得
constexpr void	SetError (ErrorType error) noexcept
	エラーを設定
constexpr void	Success () noexcept
	エラーを無効化
constexpr ResultWrapper &	operator= (const ErrorType &rhs) noexcept
	エラーの代入演算子
constexpr bool	operator== (const ErrorType &rhs) const noexcept
	エラーの等価演算子
constexpr bool	operator!= (const ErrorType &rhs) const noexcept
	エラーの不等価演算子
constexpr bool	HasError () const noexcept
	エラーが発生しているかを取得
constexpr bool	IsSucceeded () const noexcept
	エラーが発生していないかを取得

静的公開メンバ関数
static constexpr ResultWrapper	Succeeded () noexcept
	エラーのないオブジェクトを取得

静的公開変数類
static constexpr ErrorType	kNoError = noErrorValue
	エラーが発生していない事を表す値
static constexpr ErrorType	kDefaultError = defaultErrorValue
	エラーの初期値

詳解

template<typename ErrorType, ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>
class MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >

エラーをラップするテンプレートクラス

テンプレート引数

ErrorType	エラーを表す型
noErrorValue	ErrorTypeで指定した型で，エラーが発生していない事を表す値
defaultErrorValue	クラス生成時の初期値．省略時はnoErrorValueと同じ

構築子と解体子

ResultWrapper()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::ResultWrapper ( ErrorType error )

inlineconstexprnoexcept

エラー設定用コンストラクタ

引数

[in]

error

設定するエラー

関数詳解

GetError()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

ErrorType MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::GetError ( ) const

inlinenodiscardconstexprnoexcept

エラーを取得

戻り値

設定されているエラー

GetErrorCode()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

std::underlying_type_t< ErrorType > MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::GetErrorCode ( ) const

inlinenodiscardconstexprnoexcept

エラーコードを取得

戻り値

設定されているエラーを基底型にキャストした値

HasError()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

bool MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::HasError ( ) const

inlinenodiscardconstexprnoexcept

エラーが発生しているかを取得

戻り値

true	エラーが発生している
false	エラーは発生していない

IsSucceeded()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

bool MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::IsSucceeded ( ) const

inlinenodiscardconstexprnoexcept

エラーが発生していないかを取得

戻り値

true	エラーは発生していない
false	エラーが発生している

覚え書き

HasError()と逆の結果を返す

operator!=()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

bool MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::operator!= ( const ErrorType & rhs ) const

inlineconstexprnoexcept

エラーの不等価演算子

引数

[in]

rhs

比較するエラー

戻り値

true	不等価
false	等価

operator=()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

ResultWrapper & MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::operator= ( const ErrorType & rhs )

inlineconstexprnoexcept

エラーの代入演算子

引数

[in]

rhs

代入するエラー

operator==()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

bool MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::operator== ( const ErrorType & rhs ) const

inlineconstexprnoexcept

エラーの等価演算子

引数

[in]

rhs

比較するエラー

戻り値

true	等価
false	不等価

SetError()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

void MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::SetError ( ErrorType error )

inlineconstexprnoexcept

エラーを設定

引数

[in]

error

設定するエラー

Succeeded()

template<typename ErrorType , ErrorType noErrorValue = ErrorType(), ErrorType defaultErrorValue = noErrorValue>

static constexpr ResultWrapper MGL::ResultWrapper< ErrorType, noErrorValue, defaultErrorValue >::Succeeded ( )

inlinestaticconstexprnoexcept

エラーのないオブジェクトを取得

戻り値

エラーのないオブジェクト

---

このクラス詳解は次のファイルから抽出されました:

• /Users/acerola/work/mgl-work/mgl/include/mgl/common/mgl_result_wrapper.h