struct BitstreamParserHelper

Declaration

struct BitstreamParserHelper { /* full declaration omitted */ };

Description

Helper to parse any bitstream remark container.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:89

Member Variables

public llvm::BitstreamCursor Stream

The Bitstream reader.

public llvm::BitstreamBlockInfo BlockInfo

The block info block.

Method Overview

• public BitstreamParserHelper(llvm::StringRef Buffer)
• public bool atEndOfStream()
• public Expected<bool> isMetaBlock()
• public Expected<bool> isRemarkBlock()
• public llvm::Error parseBlockInfoBlock()
• public Expected<std::array<char, 4>> parseMagic()
• public void skipToEnd()

Methods

¶BitstreamParserHelper(llvm::StringRef Buffer)

Description

Start parsing at \p Buffer.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:95

Parameters

llvm::StringRef Buffer

¶bool atEndOfStream()

Description

Return true if the parser reached the end of the stream.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:108

¶Expected<bool> isMetaBlock()

Description

Return true if the next block is a META_BLOCK. This function does not move the cursor.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:103

¶Expected<bool> isRemarkBlock()

Description

Return true if the next block is a REMARK_BLOCK. This function does not move the cursor.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:106

¶llvm::Error parseBlockInfoBlock()

Description

Parse the block info block containing all the abbrevs. This needs to be called before calling any other parsing function.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:100

¶Expected<std::array<char, 4>> parseMagic()

Description

Parse the magic number.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:97

¶void skipToEnd()

Description

Jump to the end of the stream, skipping everything.

Declared at: llvm/include/llvm/Remarks/BitstreamRemarkParser.h:110