LLVM  6.0.0svn
Public Member Functions | Protected Member Functions | List of all members
llvm::BinaryStream Class Referenceabstract

An interface for accessing data in a stream-like format, but which discourages copying. More...

#include "llvm/Support/BinaryStream.h"

Inheritance diagram for llvm::BinaryStream:
Inheritance graph
[legend]

Public Member Functions

virtual ~BinaryStream ()=default
 
virtual llvm::support::endianness getEndian () const =0
 
virtual Error readBytes (uint32_t Offset, uint32_t Size, ArrayRef< uint8_t > &Buffer)=0
 Given an offset into the stream and a number of bytes, attempt to read the bytes and set the output ArrayRef to point to data owned by the stream. More...
 
virtual Error readLongestContiguousChunk (uint32_t Offset, ArrayRef< uint8_t > &Buffer)=0
 Given an offset into the stream, read as much as possible without copying any data. More...
 
virtual uint32_t getLength ()=0
 Return the number of bytes of data in this stream. More...
 

Protected Member Functions

Error checkOffset (uint32_t Offset, uint32_t DataSize)
 

Detailed Description

An interface for accessing data in a stream-like format, but which discourages copying.

Instead of specifying a buffer in which to copy data on a read, the API returns an ArrayRef to data owned by the stream's implementation. Since implementations may not necessarily store data in a single contiguous buffer (or even in memory at all), in such cases a it may be necessary for an implementation to cache such a buffer so that it can return it.

Definition at line 28 of file BinaryStream.h.

Constructor & Destructor Documentation

◆ ~BinaryStream()

virtual llvm::BinaryStream::~BinaryStream ( )
virtualdefault

Member Function Documentation

◆ checkOffset()

Error llvm::BinaryStream::checkOffset ( uint32_t  Offset,
uint32_t  DataSize 
)
inlineprotected

◆ getEndian()

virtual llvm::support::endianness llvm::BinaryStream::getEndian ( ) const
pure virtual

◆ getLength()

virtual uint32_t llvm::BinaryStream::getLength ( )
pure virtual

◆ readBytes()

virtual Error llvm::BinaryStream::readBytes ( uint32_t  Offset,
uint32_t  Size,
ArrayRef< uint8_t > &  Buffer 
)
pure virtual

Given an offset into the stream and a number of bytes, attempt to read the bytes and set the output ArrayRef to point to data owned by the stream.

Implemented in llvm::FileBufferByteStream, llvm::msf::WritableMappedBlockStream, llvm::MutableBinaryByteStream, llvm::msf::MappedBlockStream, llvm::BinaryByteStream, and llvm::BinaryItemStream< T, Traits >.

Referenced by llvm::BinaryStreamRef::readBytes().

◆ readLongestContiguousChunk()

virtual Error llvm::BinaryStream::readLongestContiguousChunk ( uint32_t  Offset,
ArrayRef< uint8_t > &  Buffer 
)
pure virtual

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