GenericMemoryBuffer< Allocator >

Represents an in-memory output byte stream. More...

#include <fwd.h>

Collaboration diagram for GenericMemoryBuffer< Allocator >:

Public Types
typedef char	Ch

Public Member Functions
	GenericMemoryBuffer (Allocator *allocator=0, size_t capacity=kDefaultCapacity)
void	Put (Ch c)
void	Flush ()
void	Clear ()
void	ShrinkToFit ()
Ch *	Push (size_t count)
void	Pop (size_t count)
const Ch *	GetBuffer () const
size_t	GetSize () const

Public Attributes
internal::Stack< Allocator >	stack_

Static Public Attributes
static const size_t	kDefaultCapacity = 256

Detailed Description

template<typename Allocator = CrtAllocator>
struct GenericMemoryBuffer< Allocator >

Represents an in-memory output byte stream.

This class is mainly for being wrapped by EncodedOutputStream or AutoUTFOutputStream.

It is similar to FileWriteBuffer but the destination is an in-memory buffer instead of a file.

Differences between MemoryBuffer and StringBuffer:

1. StringBuffer has Encoding but MemoryBuffer is only a byte buffer.
2. StringBuffer::GetString() returns a null-terminated string. MemoryBuffer::GetBuffer() returns a buffer without terminator.

Template Parameters

Allocator

type for allocating memory buffer.

Note

implements Stream concept

Definition at line 74 of file fwd.h.

Member Typedef Documentation

Ch

typedef char Ch

Definition at line 38 of file memorybuffer.h.

Constructor & Destructor Documentation

GenericMemoryBuffer()

GenericMemoryBuffer ( Allocator *  allocator = 0, size_t  capacity = kDefaultCapacity  )

inline

Definition at line 40 of file memorybuffer.h.

: stack_(allocator, capacity) {}

Member Function Documentation

Clear()

void Clear ( )

inline

Definition at line 45 of file memorybuffer.h.

{ stack_.Clear(); }

Flush()

void Flush ( )

inline

Definition at line 43 of file memorybuffer.h.

{}

GetBuffer()

const Ch* GetBuffer ( ) const

inline

Definition at line 50 of file memorybuffer.h.

                                {
        return stack_.template Bottom<Ch>();
    }

GetSize()

size_t GetSize ( ) const

inline

Definition at line 54 of file memorybuffer.h.

{ return stack_.GetSize(); }

Pop()

void Pop ( size_t  count )

inline

Definition at line 48 of file memorybuffer.h.

{ stack_.template Pop<Ch>(count); }

Push()

Ch* Push ( size_t  count )

inline

Definition at line 47 of file memorybuffer.h.

{ return stack_.template Push<Ch>(count); }

Put()

void Put ( Ch  c )

inline

Definition at line 42 of file memorybuffer.h.

{ *stack_.template Push<Ch>() = c; }

ShrinkToFit()

void ShrinkToFit ( )

inline

Definition at line 46 of file memorybuffer.h.

{ stack_.ShrinkToFit(); }

Member Data Documentation

kDefaultCapacity

const size_t kDefaultCapacity = 256

static

Definition at line 56 of file memorybuffer.h.

stack_

internal::Stack<Allocator> stack_

mutable

Definition at line 57 of file memorybuffer.h.

---

The documentation for this struct was generated from the following files:

• rapidjson/fwd.h
• rapidjson/memorybuffer.h