class WritableBinaryStreamRef

Declaration

class WritableBinaryStreamRef : public BinaryStreamRefBase { /* full declaration omitted */ };

Description

Common stuff for mutable and immutable StreamRefs.

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:220

Inherits from: BinaryStreamRefBase

Method Overview

• private WritableBinaryStreamRef(std::shared_ptr<WritableBinaryStream> Impl, uint64_t ViewOffset, Optional<uint64_t> Length)
• public WritableBinaryStreamRef()
• public WritableBinaryStreamRef(llvm::WritableBinaryStream & Stream)
• public WritableBinaryStreamRef(llvm::WritableBinaryStream & Stream, uint64_t Offset, Optional<uint64_t> Length)
• public WritableBinaryStreamRef(MutableArrayRef<uint8_t> Data, llvm::support::endianness Endian)
• public WritableBinaryStreamRef(const llvm::WritableBinaryStreamRef & Other)
• public WritableBinaryStreamRef(llvm::WritableBinaryStreamRef && Other)
• public WritableBinaryStreamRef(llvm::WritableBinaryStreamRef & S, uint64_t Offset, uint64_t Length)
• private llvm::Error checkOffsetForWrite(uint64_t Offset, uint64_t DataSize) const
• public llvm::Error commit()
• public llvm::BinaryStreamRef operator BinaryStreamRef() const
• public llvm::Error writeBytes(uint64_t Offset, ArrayRef<uint8_t> Data) const

Methods

¶WritableBinaryStreamRef(
    std::shared_ptr<WritableBinaryStream> Impl,
    uint64_t ViewOffset,
    Optional<uint64_t> Length)

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:224

Parameters

std::shared_ptr<WritableBinaryStream> Impl

uint64_t ViewOffset

Optional<uint64_t> Length

¶WritableBinaryStreamRef()

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:238

¶WritableBinaryStreamRef(
    llvm::WritableBinaryStream& Stream)

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:239

Parameters

llvm::WritableBinaryStream& Stream

¶WritableBinaryStreamRef(
    llvm::WritableBinaryStream& Stream,
    uint64_t Offset,
    Optional<uint64_t> Length)

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:240

Parameters

llvm::WritableBinaryStream& Stream

uint64_t Offset

Optional<uint64_t> Length

¶WritableBinaryStreamRef(
    MutableArrayRef<uint8_t> Data,
    llvm::support::endianness Endian)

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:242

Parameters

MutableArrayRef<uint8_t> Data

llvm::support::endianness Endian

¶WritableBinaryStreamRef(
    const llvm::WritableBinaryStreamRef& Other)

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:244

Parameters

const llvm::WritableBinaryStreamRef& Other

¶WritableBinaryStreamRef(
    llvm::WritableBinaryStreamRef&& Other)

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:248

Parameters

llvm::WritableBinaryStreamRef&& Other

¶WritableBinaryStreamRef(
    llvm::WritableBinaryStreamRef& S,
    uint64_t Offset,
    uint64_t Length)

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:252

Parameters

llvm::WritableBinaryStreamRef& S

uint64_t Offset

uint64_t Length

¶llvm::Error checkOffsetForWrite(
    uint64_t Offset,
    uint64_t DataSize) const

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:228

Parameters

uint64_t Offset

uint64_t DataSize

¶llvm::Error commit()

Description

For buffered streams, commits changes to the backing store.

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:267

¶llvm::BinaryStreamRef operator BinaryStreamRef()
    const

Description

Conver this WritableBinaryStreamRef to a read-only BinaryStreamRef.

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:264

¶llvm::Error writeBytes(
    uint64_t Offset,
    ArrayRef<uint8_t> Data) const

Description

Given an Offset into this WritableBinaryStreamRef and some input data, writes the data to the underlying stream.

Declared at: llvm/include/llvm/Support/BinaryStreamRef.h:261

Parameters

uint64_t Offset

ArrayRef<uint8_t> Data

Returns

a success error code if the data could fit within the underlying stream at the specified location and the implementation could write the data, and an appropriate error code otherwise.