xgboost::collective::Result Struct Reference

An error type that's easier to handle than throwing dmlc exception. We can record and propagate the system error code. More...

#include <result.h>

Collaboration diagram for xgboost::collective::Result:

Public Member Functions
	Result () noexcept(true)=default
	Result (std::string msg)
	Result (std::string msg, std::error_code errc)
	Result (std::string msg, Result &&prev)
	Result (std::string msg, std::error_code errc, Result &&prev)
	Result (Result const &that)=delete
Result &	operator= (Result const &that)=delete
	Result (Result &&that)=default
Result &	operator= (Result &&that)=default
bool	OK () const noexcept(true)
std::string	Report () const
auto	Code () const
	Return the root system error. This might return success if there's no system error. More...
bool	operator== (Result const &that) const noexcept(true)

Friends
Result	operator+ (Result &&lhs, Result &&rhs)

Detailed Description

An error type that's easier to handle than throwing dmlc exception. We can record and propagate the system error code.

Constructor & Destructor Documentation

Result() [1/7]

xgboost::collective::Result::Result ( )

defaultnoexcept

Result() [2/7]

xgboost::collective::Result::Result ( std::string  msg )

inlineexplicit

Result() [3/7]

xgboost::collective::Result::Result ( std::string  msg, std::error_code  errc  )

inlineexplicit

Result() [4/7]

xgboost::collective::Result::Result ( std::string  msg, Result &&  prev  )

inline

Result() [5/7]

xgboost::collective::Result::Result ( std::string  msg, std::error_code  errc, Result &&  prev  )

inline

Result() [6/7]

xgboost::collective::Result::Result ( Result const &  that )

delete

Result() [7/7]

xgboost::collective::Result::Result ( Result &&  that )

default

Member Function Documentation

Code()

auto xgboost::collective::Result::Code ( ) const

inline

Return the root system error. This might return success if there's no system error.

OK()

bool xgboost::collective::Result::OK ( ) const

inlinenoexcept

operator=() [1/2]

Result& xgboost::collective::Result::operator= ( Result &&  that )

default

operator=() [2/2]

Result& xgboost::collective::Result::operator= ( Result const &  that )

delete

operator==()

bool xgboost::collective::Result::operator== ( Result const &  that ) const

inlinenoexcept

Report()

std::string xgboost::collective::Result::Report ( ) const

inline

Friends And Related Function Documentation

operator+

Result operator+ ( Result &&  lhs, Result &&  rhs  )

friend

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/xgboost/checkouts/latest/include/xgboost/collective/result.h