A copyable, read‐only window into a BinaryStream.
Synopsis
Declared in <llvm/Support/BinaryStreamRef.h>
class BinaryStreamRef
: public BinaryStreamRefBase<BinaryStreamRef, BinaryStream>Description
BinaryStreamRef is to BinaryStream what ArrayRef is to an Array. It provides copy‐semantics and read only access to a "window" of the underlying BinaryStream. Note that BinaryStreamRef is not a BinaryStream. That is to say, it does not inherit and override the methods of BinaryStream. In general, you should not pass around pointers or references to BinaryStreams and use inheritance to achieve polymorphism. Instead, you should pass around BinaryStreamRefs by value and achieve polymorphism that way.
Base Classes
Name |
Description |
Common stuff for mutable and immutable StreamRefs. |
Member Functions
Name |
Description |
|
Constructors |
Assignment operators |
|
Return a new BinaryStreamRef with the last |
|
Return a new BinaryStreamRef with the first |
|
Return a new BinaryStreamRef with the first and last |
|
Return the endianness of multi‐byte values in the underlying stream. |
|
Return the length in bytes of this stream reference's view. |
|
Return a new BinaryStreamRef with only the last |
|
Return a new BinaryStreamRef with only the first |
|
Given an Offset into this StreamRef and a Size, return a reference to a buffer owned by the stream. |
|
Given an Offset into this BinaryStreamRef, return a reference to the largest buffer the stream could support without necessitating a copy. |
|
Return a new BinaryStreamRef with the first |
|
Return true if this reference refers to a valid underlying stream. |
Protected Member Functions
Name |
Description |
Assignment operators |
|
Validate that |
Protected Data Members
Name |
Description |
Non‐owning pointer to the underlying stream implementation. |
|
Explicit length of this view, or unset when length‐tracking. |
|
Shared ownership of the underlying stream, if any. |
|
Byte offset into the underlying stream where this view begins. |
Friends
Name |
Description |
A copyable, writable window into a WritableBinaryStream. |
|
Common stuff for mutable and immutable StreamRefs. |
Non-Member Functions
Name |
Description |
Compare two stream references for equality of impl, offset, and length. |
|
Read a complete record from a stream at a random offset. |
|
Read one CodeView symbol record from |
Created with MrDocs