WPILibC++  2020.3.2-60-g3011ebe
wpi::ErrorList Class Referencefinal

Special ErrorInfo subclass representing a list of ErrorInfos. More...

#include <Error.h>

Inheritance diagram for wpi::ErrorList:
wpi::ErrorInfo< ErrorList > wpi::ErrorInfoBase

Public Member Functions

void log (raw_ostream &OS) const override
 Print an error message to an output stream.
 
std::error_code convertToErrorCode () const override
 Convert this error to a std::error_code. More...
 
- Public Member Functions inherited from wpi::ErrorInfo< ErrorList >
const void * dynamicClassID () const override
 
bool isA (const void *const ClassID) const override
 
- Public Member Functions inherited from wpi::ErrorInfoBase
virtual std::string message () const
 Return the error message as a string.
 
template<typename ErrorInfoT >
bool isA () const
 

Static Public Attributes

static char ID
 

Friends

template<typename... HandlerTs>
Error handleErrors (Error E, HandlerTs &&... Handlers)
 Pass the ErrorInfo(s) contained in E to their respective handlers. More...
 
Error joinErrors (Error, Error)
 Concatenate errors. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from wpi::ErrorInfo< ErrorList >
static const void * classID ()
 
- Static Public Member Functions inherited from wpi::ErrorInfoBase
static const void * classID ()
 

Detailed Description

Special ErrorInfo subclass representing a list of ErrorInfos.

Instances of this class are constructed by joinError.

Member Function Documentation

◆ convertToErrorCode()

std::error_code wpi::ErrorList::convertToErrorCode ( ) const
overridevirtual

Convert this error to a std::error_code.

This is a temporary crutch to enable interaction with code still using std::error_code. It will be removed in the future.

Implements wpi::ErrorInfoBase.

Friends And Related Function Documentation

◆ handleErrors

template<typename... HandlerTs>
Error handleErrors ( Error  E,
HandlerTs &&...  Handlers 
)
friend

Pass the ErrorInfo(s) contained in E to their respective handlers.

Any unhandled errors (or Errors returned by handlers) are re-concatenated and returned. Because this function returns an error, its result must also be checked or returned. If you intend to handle all errors use handleAllErrors (which returns void, and will abort() on unhandled errors) instead.

◆ joinErrors

Error joinErrors ( Error  E1,
Error  E2 
)
friend

Concatenate errors.

The resulting Error is unchecked, and contains the ErrorInfo(s), if any, contained in E1, followed by the ErrorInfo(s), if any, contained in E2.


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