LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
llvm::InstrProfError Class Reference

#include "llvm/ProfileData/InstrProf.h"

Inheritance diagram for llvm::InstrProfError:
Inheritance graph
[legend]

Public Member Functions

 InstrProfError (instrprof_error Err, const Twine &ErrStr=Twine())
 
std::string message () const override
 Return the error message as a string.
 
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.
 
instrprof_error get () const
 
const std::string & getMessage () const
 
- Public Member Functions inherited from llvm::ErrorInfo< InstrProfError >
const void * dynamicClassID () const override
 
bool isA (const void *const ClassID) const override
 
- Public Member Functions inherited from llvm::ErrorInfoBase
virtual ~ErrorInfoBase ()=default
 
virtual void log (raw_ostream &OS) const =0
 Print an error message to an output stream.
 
virtual std::string message () const
 Return the error message as a string.
 
virtual std::error_code convertToErrorCode () const =0
 Convert this error to a std::error_code.
 
virtual const void * dynamicClassID () const =0
 
virtual bool isA (const void *const ClassID) const
 
template<typename ErrorInfoT >
bool isA () const
 

Static Public Member Functions

static std::pair< instrprof_error, std::string > take (Error E)
 Consume an Error and return the raw enum value contained within it, and the optional error message.
 
- Static Public Member Functions inherited from llvm::ErrorInfo< InstrProfError >
static const void * classID ()
 
- Static Public Member Functions inherited from llvm::ErrorInfoBase
static const void * classID ()
 

Static Public Attributes

static char ID = 0
 

Detailed Description

Definition at line 404 of file InstrProf.h.

Constructor & Destructor Documentation

◆ InstrProfError()

llvm::InstrProfError::InstrProfError ( instrprof_error  Err,
const Twine ErrStr = Twine() 
)
inline

Definition at line 406 of file InstrProf.h.

References assert(), and llvm::success.

Member Function Documentation

◆ convertToErrorCode()

std::error_code llvm::InstrProfError::convertToErrorCode ( ) const
inlineoverridevirtual

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 llvm::ErrorInfoBase.

Definition at line 415 of file InstrProf.h.

References llvm::make_error_code().

◆ get()

instrprof_error llvm::InstrProfError::get ( ) const
inline

Definition at line 419 of file InstrProf.h.

Referenced by llvm::InstrProfReader::error(), readMemprof(), and take().

◆ getMessage()

const std::string & llvm::InstrProfError::getMessage ( ) const
inline

Definition at line 420 of file InstrProf.h.

Referenced by llvm::InstrProfReader::error(), and take().

◆ log()

void llvm::InstrProfError::log ( raw_ostream OS) const
inlineoverridevirtual

Print an error message to an output stream.

Implements llvm::ErrorInfoBase.

Definition at line 413 of file InstrProf.h.

References message(), and OS.

◆ message()

std::string llvm::InstrProfError::message ( ) const
overridevirtual

Return the error message as a string.

Reimplemented from llvm::ErrorInfoBase.

Definition at line 255 of file InstrProf.cpp.

References getInstrProfErrString().

Referenced by log(), and readMemprof().

◆ take()

static std::pair< instrprof_error, std::string > llvm::InstrProfError::take ( Error  E)
inlinestatic

Consume an Error and return the raw enum value contained within it, and the optional error message.

The Error must either be a success value, or contain a single InstrProfError.

Definition at line 425 of file InstrProf.h.

References assert(), E, get(), getMessage(), llvm::handleAllErrors(), and llvm::success.

Referenced by llvm::IndexedInstrProfReader::getSymtab().

Member Data Documentation

◆ ID

char llvm::InstrProfError::ID = 0
static

Definition at line 436 of file InstrProf.h.


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