WPILibC++ 2024.3.2
wpi::SmallVectorMemoryBuffer Class Reference

SmallVector-backed MemoryBuffer instance. More...

#include </home/runner/work/allwpilib/allwpilib/wpiutil/src/main/native/thirdparty/llvm/include/wpi/SmallVectorMemoryBuffer.h>

Inheritance diagram for wpi::SmallVectorMemoryBuffer:
wpi::MemoryBuffer

Public Member Functions

 SmallVectorMemoryBuffer (SmallVectorImpl< uint8_t > &&sv)
 Construct an SmallVectorMemoryBuffer from the given SmallVector r-value. More...
 
 SmallVectorMemoryBuffer (SmallVectorImpl< uint8_t > &&sv, std::string_view name)
 Construct a named SmallVectorMemoryBuffer from the given SmallVector r-value and StringRef. More...
 
 ~SmallVectorMemoryBuffer () override
 
std::string_view GetBufferIdentifier () const override
 Return an identifier for this buffer, typically the filename it was read from. More...
 
BufferKind GetBufferKind () const override
 Return information on the memory mechanism used to support the MemoryBuffer. More...
 
- Public Member Functions inherited from wpi::MemoryBuffer
 MemoryBuffer (const MemoryBuffer &)=delete
 
MemoryBufferoperator= (const MemoryBuffer &)=delete
 
virtual ~MemoryBuffer ()
 
const uint8_t * begin () const
 
const uint8_t * end () const
 
size_t size () const
 
std::span< const uint8_t > GetBuffer () const
 
std::span< const char > GetCharBuffer () const
 
virtual std::string_view GetBufferIdentifier () const
 Return an identifier for this buffer, typically the filename it was read from. More...
 
virtual BufferKind GetBufferKind () const =0
 Return information on the memory mechanism used to support the MemoryBuffer. More...
 
MemoryBufferRef GetMemBufferRef () const
 

Additional Inherited Members

- Public Types inherited from wpi::MemoryBuffer
enum  BufferKind { MemoryBuffer_Malloc , MemoryBuffer_MMap }
 The kind of memory backing used to support the MemoryBuffer. More...
 
- Static Public Member Functions inherited from wpi::MemoryBuffer
static std::unique_ptr< MemoryBufferGetFile (std::string_view filename, std::error_code &ec, int64_t fileSize=-1)
 Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful, otherwise returning null. More...
 
static std::unique_ptr< MemoryBufferGetFileAsStream (std::string_view filename, std::error_code &ec)
 Read all of the specified file into a MemoryBuffer as a stream (i.e. More...
 
static std::unique_ptr< MemoryBufferGetOpenFileSlice (fs::file_t f, std::string_view filename, std::error_code &ec, uint64_t mapSize, int64_t offset)
 Given an already-open file descriptor, map some slice of it into a MemoryBuffer. More...
 
static std::unique_ptr< MemoryBufferGetOpenFile (fs::file_t f, std::string_view filename, std::error_code &ec, uint64_t fileSize)
 Given an already-open file descriptor, read the file and return a MemoryBuffer. More...
 
static std::unique_ptr< MemoryBufferGetMemBuffer (std::span< const uint8_t > inputData, std::string_view bufferName="")
 Open the specified memory range as a MemoryBuffer. More...
 
static std::unique_ptr< MemoryBufferGetMemBuffer (MemoryBufferRef ref)
 
static std::unique_ptr< MemoryBufferGetMemBufferCopy (std::span< const uint8_t > inputData, std::string_view bufferName="")
 Open the specified memory range as a MemoryBuffer, copying the contents and taking ownership of it. More...
 
static std::unique_ptr< MemoryBufferGetFileSlice (std::string_view filename, std::error_code &ec, uint64_t mapSize, uint64_t offset)
 Map a subrange of the specified file as a MemoryBuffer. More...
 
- Protected Member Functions inherited from wpi::MemoryBuffer
 MemoryBuffer ()=default
 
void Init (const uint8_t *bufStart, const uint8_t *bufEnd)
 

Detailed Description

SmallVector-backed MemoryBuffer instance.

This class enables efficient construction of MemoryBuffers from SmallVector instances.

Constructor & Destructor Documentation

◆ SmallVectorMemoryBuffer() [1/2]

wpi::SmallVectorMemoryBuffer::SmallVectorMemoryBuffer ( SmallVectorImpl< uint8_t > &&  sv)
inline

Construct an SmallVectorMemoryBuffer from the given SmallVector r-value.

◆ SmallVectorMemoryBuffer() [2/2]

wpi::SmallVectorMemoryBuffer::SmallVectorMemoryBuffer ( SmallVectorImpl< uint8_t > &&  sv,
std::string_view  name 
)
inline

Construct a named SmallVectorMemoryBuffer from the given SmallVector r-value and StringRef.

◆ ~SmallVectorMemoryBuffer()

wpi::SmallVectorMemoryBuffer::~SmallVectorMemoryBuffer ( )
override

Member Function Documentation

◆ GetBufferIdentifier()

std::string_view wpi::SmallVectorMemoryBuffer::GetBufferIdentifier ( ) const
inlineoverridevirtual

Return an identifier for this buffer, typically the filename it was read from.

Reimplemented from wpi::MemoryBuffer.

◆ GetBufferKind()

BufferKind wpi::SmallVectorMemoryBuffer::GetBufferKind ( ) const
inlineoverridevirtual

Return information on the memory mechanism used to support the MemoryBuffer.

Implements wpi::MemoryBuffer.


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