LLVM  6.0.0svn
Public Member Functions | List of all members
llvm::MutableBinaryByteStream Class Reference

An implementation of BinaryStream which holds its entire data set in a single contiguous buffer. More...

#include "llvm/Support/BinaryByteStream.h"

Inheritance diagram for llvm::MutableBinaryByteStream:
Inheritance graph
[legend]
Collaboration diagram for llvm::MutableBinaryByteStream:
Collaboration graph
[legend]

Public Member Functions

 MutableBinaryByteStream ()=default
 
 MutableBinaryByteStream (MutableArrayRef< uint8_t > Data, llvm::support::endianness Endian)
 
llvm::support::endianness getEndian () const override
 
Error readBytes (uint32_t Offset, uint32_t Size, ArrayRef< uint8_t > &Buffer) override
 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...
 
Error readLongestContiguousChunk (uint32_t Offset, ArrayRef< uint8_t > &Buffer) override
 Given an offset into the stream, read as much as possible without copying any data. More...
 
uint32_t getLength () override
 Return the number of bytes of data in this stream. More...
 
Error writeBytes (uint32_t Offset, ArrayRef< uint8_t > Buffer) override
 Attempt to write the given bytes into the stream at the desired offset. More...
 
Error commit () override
 For buffered streams, commits changes to the backing store. More...
 
MutableArrayRef< uint8_t > data () const
 
- Public Member Functions inherited from llvm::WritableBinaryStream
 ~WritableBinaryStream () override=default
 
- Public Member Functions inherited from llvm::BinaryStream
virtual ~BinaryStream ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from llvm::BinaryStream
Error checkOffset (uint32_t Offset, uint32_t DataSize)
 

Detailed Description

An implementation of BinaryStream which holds its entire data set in a single contiguous buffer.

As with BinaryByteStream, the mutable version also guarantees that no read operation will ever incur a copy, and similarly it does not own the underlying buffer.

Definition at line 90 of file BinaryByteStream.h.

Constructor & Destructor Documentation

◆ MutableBinaryByteStream() [1/2]

llvm::MutableBinaryByteStream::MutableBinaryByteStream ( )
default

◆ MutableBinaryByteStream() [2/2]

llvm::MutableBinaryByteStream::MutableBinaryByteStream ( MutableArrayRef< uint8_t >  Data,
llvm::support::endianness  Endian 
)
inline

Definition at line 93 of file BinaryByteStream.h.

Member Function Documentation

◆ commit()

Error llvm::MutableBinaryByteStream::commit ( )
inlineoverridevirtual

For buffered streams, commits changes to the backing store.

Implements llvm::WritableBinaryStream.

Definition at line 125 of file BinaryByteStream.h.

References llvm::Error::success().

◆ data()

MutableArrayRef<uint8_t> llvm::MutableBinaryByteStream::data ( ) const
inline

◆ getEndian()

llvm::support::endianness llvm::MutableBinaryByteStream::getEndian ( ) const
inlineoverridevirtual

Implements llvm::BinaryStream.

Definition at line 97 of file BinaryByteStream.h.

◆ getLength()

uint32_t llvm::MutableBinaryByteStream::getLength ( )
inlineoverridevirtual

Return the number of bytes of data in this stream.

Implements llvm::BinaryStream.

Definition at line 111 of file BinaryByteStream.h.

Referenced by llvm::pdb::DbiStreamBuilder::getSourceFileNameIndex().

◆ readBytes()

Error llvm::MutableBinaryByteStream::readBytes ( uint32_t  Offset,
uint32_t  Size,
ArrayRef< uint8_t > &  Buffer 
)
inlineoverridevirtual

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.

Implements llvm::BinaryStream.

Definition at line 101 of file BinaryByteStream.h.

◆ readLongestContiguousChunk()

Error llvm::MutableBinaryByteStream::readLongestContiguousChunk ( uint32_t  Offset,
ArrayRef< uint8_t > &  Buffer 
)
inlineoverridevirtual

Given an offset into the stream, read as much as possible without copying any data.

Implements llvm::BinaryStream.

Definition at line 106 of file BinaryByteStream.h.

◆ writeBytes()

Error llvm::MutableBinaryByteStream::writeBytes ( uint32_t  Offset,
ArrayRef< uint8_t >  Data 
)
inlineoverridevirtual

Attempt to write the given bytes into the stream at the desired offset.

This will always necessitate a copy. Cannot shrink or grow the stream, only writes into existing allocated space.

Implements llvm::WritableBinaryStream.

Definition at line 113 of file BinaryByteStream.h.

References llvm::BinaryStream::checkOffset(), llvm::BinaryByteStream::Data, llvm::ArrayRef< T >::data(), llvm::ArrayRef< T >::empty(), llvm::ArrayRef< T >::size(), and llvm::Error::success().


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