llvm::remarks::RemarkStreamer Class Reference

#include "llvm/Remarks/RemarkStreamer.h"

Public Member Functions
LLVM_ABI	RemarkStreamer (std::unique_ptr< remarks::RemarkSerializer > RemarkSerializer, std::optional< StringRef > Filename=std::nullopt)
LLVM_ABI	~RemarkStreamer ()
std::optional< StringRef >	getFilename () const
	Return the filename that the remark diagnostics are emitted to.
raw_ostream &	getStream ()
	Return stream that the remark diagnostics are emitted to.
remarks::RemarkSerializer &	getSerializer ()
	Return the serializer used for this stream.
std::unique_ptr< remarks::RemarkSerializer >	releaseSerializer ()
	Release the underlying RemarkSerializer.
LLVM_ABI Error	setFilter (StringRef Filter)
	Set a pass filter based on a regex Filter.
LLVM_ABI bool	matchesFilter (StringRef Str)
	Check wether the string matches the filter.
LLVM_ABI bool	needsSection () const
	Check if the remarks NEED to have metadata in an object section.
LLVM_ABI bool	wantsSection () const
	Check if the remarks should store associated metadata if suppported.

Detailed Description

Definition at line 44 of file RemarkStreamer.h.

Constructor & Destructor Documentation

RemarkStreamer()

RemarkStreamer::RemarkStreamer	(	std::unique_ptr< remarks::RemarkSerializer >	RemarkSerializer,
		std::optional< StringRef >	Filename = std::nullopt )

Definition at line 28 of file RemarkStreamer.cpp.

References llvm::move().

~RemarkStreamer()

RemarkStreamer::~RemarkStreamer

(

)

Definition at line 35 of file RemarkStreamer.cpp.

References assert().

Member Function Documentation

getFilename()

std::optional< StringRef > llvm::remarks::RemarkStreamer::getFilename ( ) const

inline

Return the filename that the remark diagnostics are emitted to.

Definition at line 59 of file RemarkStreamer.h.

getSerializer()

remarks::RemarkSerializer & llvm::remarks::RemarkStreamer::getSerializer ( )

inline

Return the serializer used for this stream.

Definition at line 65 of file RemarkStreamer.h.

getStream()

raw_ostream & llvm::remarks::RemarkStreamer::getStream ( )

inline

Return stream that the remark diagnostics are emitted to.

Definition at line 63 of file RemarkStreamer.h.

matchesFilter()

bool RemarkStreamer::matchesFilter

(

StringRef

Str

)

Check wether the string matches the filter.

Definition at line 53 of file RemarkStreamer.cpp.

needsSection()

bool RemarkStreamer::needsSection

(

)

const

Check if the remarks NEED to have metadata in an object section.

Definition at line 60 of file RemarkStreamer.cpp.

References llvm::cl::BOU_TRUE, and EnableRemarksSection.

Referenced by wantsSection().

releaseSerializer()

std::unique_ptr< remarks::RemarkSerializer > llvm::remarks::RemarkStreamer::releaseSerializer ( )

inline

Release the underlying RemarkSerializer.

Destructing the RemarkStreamer will assert that the RemarkStreamer has been released, to ensure that the remarks were properly finalized.

Definition at line 70 of file RemarkStreamer.h.

setFilter()

Error RemarkStreamer::setFilter

(

StringRef

Filter

)

Set a pass filter based on a regex Filter.

Returns an error if the regex is invalid.

Definition at line 43 of file RemarkStreamer.cpp.

References llvm::createStringError(), llvm::Filter, and llvm::Error::success().

wantsSection()

bool RemarkStreamer::wantsSection

(

)

const

Check if the remarks should store associated metadata if suppported.

Definition at line 64 of file RemarkStreamer.cpp.

References llvm::remarks::Bitstream, llvm::cl::BOU_FALSE, EnableRemarksSection, and needsSection().

---

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

• include/llvm/Remarks/RemarkStreamer.h
• lib/Remarks/RemarkStreamer.cpp