C/C++ API Reference
Loading...
Searching...
No Matches
pw::stream::MemoryWriterBuffer< kSizeBytes > Class Template Referencefinal
Inheritance diagram for pw::stream::MemoryWriterBuffer< kSizeBytes >:
pw::stream::MemoryWriter pw::stream::SeekableWriter pw::stream::RelativeSeekableWriter pw::stream::Writer pw::stream::Stream

Public Member Functions

 MemoryWriterBuffer (MemoryWriterBuffer &&)=delete
 
MemoryWriterBufferoperator= (MemoryWriter &&)=delete
 
- Public Member Functions inherited from pw::stream::MemoryWriter
constexpr MemoryWriter (ByteSpan dest)
 
constexpr MemoryWriter (ByteSpan dest, size_t bytes_written)
 
ConstByteSpan WrittenData () const
 
void clear ()
 
std::byte * data ()
 
const std::byte * data () const
 
const std::byte & operator[] (size_t index) const
 
bool empty () const
 
size_t size () const
 
size_t bytes_written () const
 
size_t capacity () const
 
const std::byte * begin () const
 
const std::byte * end () const
 
- Public Member Functions inherited from pw::stream::Stream
constexpr bool readable () const
 
constexpr bool writable () const
 
constexpr bool seekable () const
 
constexpr bool seekable (Whence origin) const
 True if the stream supports seeking from the specified origin.
 
Result< ByteSpanRead (ByteSpan dest)
 
Result< ByteSpanRead (void *dest, size_t size_bytes)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Result< ByteSpanReadExact (ByteSpan const buffer)
 
Status Write (ConstByteSpan data)
 
Status Write (const void *data, size_t size_bytes)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Status Write (const std::byte b)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Status Seek (ptrdiff_t offset, Whence origin=kBeginning)
 
size_t Tell ()
 
size_t ConservativeReadLimit () const
 
size_t ConservativeWriteLimit () const
 

Additional Inherited Members

- Public Types inherited from pw::stream::MemoryWriter
using difference_type = ptrdiff_t
 
using reference = const std::byte &
 
using const_reference = const std::byte &
 
using pointer = const std::byte *
 
using const_pointer = const std::byte *
 
using iterator = const std::byte *
 
using const_iterator = const std::byte *
 
- Public Types inherited from pw::stream::Stream
enum  Whence : uint8_t { kBeginning = 0b001 , kCurrent = 0b010 , kEnd = 0b100 }
 Positions from which to seek. More...
 
- Static Public Attributes inherited from pw::stream::Stream
static constexpr size_t kUnlimited = std::numeric_limits<size_t>::max()
 Value returned from read/write limit if unlimited.
 
static constexpr size_t kUnknownPosition = std::numeric_limits<size_t>::max()
 Returned by Tell() if getting the position is not supported.
 
- Protected Types inherited from pw::stream::Stream
enum class  LimitType : bool { kRead , kWrite }
 

Constructor & Destructor Documentation

◆ MemoryWriterBuffer()

template<size_t kSizeBytes>
pw::stream::MemoryWriterBuffer< kSizeBytes >::MemoryWriterBuffer ( MemoryWriterBuffer< kSizeBytes > &&  )
delete

MemoryWriterBuffer is not movable, as MemoryWriter stores a pointer to the current buffer.

The buffer could be copied, but this is usually undesirable.

Member Function Documentation

◆ operator=()

template<size_t kSizeBytes>
MemoryWriterBuffer & pw::stream::MemoryWriterBuffer< kSizeBytes >::operator= ( MemoryWriter &&  )
delete

MemoryWriterBuffer is not movable, as MemoryWriter stores a pointer to the current buffer.

The buffer could be copied, but this is usually undesirable.


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