llvm::FileError Class Reference

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

#include "llvm/Support/Error.h"

Inheritance diagram for llvm::FileError:

Public Member Functions
void	log (raw_ostream &OS) const override
	Print an error message to an output stream.
std::string	messageWithoutFileInfo () const
StringRef	getFileName () const
Error	takeError ()
std::error_code	convertToErrorCode () const override
	Convert this error to a std::error_code.
Public Member Functions inherited from llvm::ErrorInfo< FileError >
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 Attributes
static char	ID = 0

Friends
Error	createFileError (const Twine &, Error)
	Concatenate a source file path and/or name with an Error.
Error	createFileError (const Twine &, size_t, Error)
	Concatenate a source file path and/or name with line number and an Error.

Additional Inherited Members
Static Public Member Functions inherited from llvm::ErrorInfo< FileError >
static const void *	classID ()
Static Public Member Functions inherited from llvm::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.

Definition at line 1328 of file Error.h.

Member Function Documentation

convertToErrorCode()

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

Definition at line 103 of file Error.cpp.

getFileName()

StringRef llvm::FileError::getFileName ( ) const

inline

Definition at line 1349 of file Error.h.

log()

void llvm::FileError::log ( raw_ostream &  OS ) const

inlineoverridevirtual

Print an error message to an output stream.

Implements llvm::ErrorInfoBase.

Definition at line 1334 of file Error.h.

References assert(), and OS.

messageWithoutFileInfo()

std::string llvm::FileError::messageWithoutFileInfo ( ) const

inline

Definition at line 1342 of file Error.h.

References OS.

takeError()

Error llvm::FileError::takeError ( )

inline

Definition at line 1351 of file Error.h.

Friends And Related Function Documentation

createFileError [1/2]

Error createFileError ( const Twine &  F, Error  E  )

friend

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

The resulting Error is unchecked.

Definition at line 1385 of file Error.h.

createFileError [2/2]

Error createFileError ( const Twine &  F, size_t  Line, Error  E  )

friend

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

The resulting Error is unchecked.

Definition at line 1391 of file Error.h.

Member Data Documentation

ID

char llvm::FileError::ID = 0

static

Definition at line 1356 of file Error.h.

---

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

• include/llvm/Support/Error.h
• lib/Testing/Support/Error.cpp