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

This class wraps a filename and another Error. More...

#include <Error.h>

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

Public Member Functions

void log (raw_ostream &OS) const override
 Print an error message to an output stream.
 
Error takeError ()
 
std::error_code convertToErrorCode () const override
 Convert this error to a std::error_code. More...
 
- Public Member Functions inherited from wpi::ErrorInfo< FileError >
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

Error createFileError (std::string, Error)
 Concatenate a source file path and/or name with an Error. More...
 

Additional Inherited Members

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

Detailed Description

This class wraps a filename and another Error.

In some cases, an error needs to live along a 'source' name, in order to show more detailed information to the user.

Member Function Documentation

◆ convertToErrorCode()

std::error_code wpi::FileError::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

◆ createFileError

Error createFileError ( std::string  F,
Error  E 
)
friend

Concatenate a source file path and/or name with an Error.

The resulting Error is unchecked.


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