[#llvm-LLVMRemarkSetupErrorInfo-00]
= xref:llvm.adoc[llvm]::LLVMRemarkSetupErrorInfo
:relfileprefix: ../
:mrdocs:

CRTP base for errors raised while setting up optimization remarks.

== Synopsis

Declared in `<llvm/IR/LLVMRemarkStreamer.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename ThisError>
struct LLVMRemarkSetupErrorInfo
    : xref:llvm/ErrorInfo-09a.adoc[ErrorInfo<ThisError>]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/ErrorInfo-09a.adoc[ErrorInfo<ThisError>]`
| Base class for user error types. Users should declare their error types like:
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/LLVMRemarkSetupErrorInfo-00/2constructor.adoc[`LLVMRemarkSetupErrorInfo`]         [.small]#[constructor]#
| Construct from an Error, capturing its message and error code.
| xref:llvm/LLVMRemarkSetupErrorInfo-00/convertToErrorCode.adoc[`convertToErrorCode`] 
| Convert this error into a std::error_code.
| xref:llvm/ErrorInfo-09a/dynamicClassID.adoc[`dynamicClassID`] 
| Return the dynamic class ID for this error instance.
| xref:llvm/ErrorInfo-09a/isA.adoc[`isA`] 
| Return true if this error is an instance of `ClassID` or a parent.
| xref:llvm/LLVMRemarkSetupErrorInfo-00/log.adoc[`log`] 
| Write this error's message to `OS.`
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ErrorInfo-09a/classID.adoc[`classID`] 
| Return the RTTI class identifier for `ThisErrT.`
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/LLVMRemarkSetupErrorInfo-00/EC.adoc[`EC`] 
| Error code associated with the setup failure.
| xref:llvm/LLVMRemarkSetupErrorInfo-00/Msg.adoc[`Msg`] 
| Human‐readable description of the setup failure.
|===


== Using Declarations

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ErrorInfo-09a/_10using.adoc[`Unnamed using`] 
| Inherit constructors from the parent error‐info type.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:llvm/LLVMRemarkSetupFileError.adoc[`LLVMRemarkSetupFileError`] 
| Error raised when the remarks output file cannot be opened.
| xref:llvm/LLVMRemarkSetupFormatError.adoc[`LLVMRemarkSetupFormatError`] 
| Error raised when a remark serialization format is invalid.
| xref:llvm/LLVMRemarkSetupPatternError.adoc[`LLVMRemarkSetupPatternError`] 
| Error raised when a remark pass filter pattern is invalid.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#