MemoryStream Struct Reference

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

#include <memorystream.h>

Public Types
typedef char	Ch

Public Member Functions
	MemoryStream (const Ch *src, size_t size)
Ch	Peek () const
Ch	Take ()
size_t	Tell () const
Ch *	PutBegin ()
void	Put (Ch)
void	Flush ()
size_t	PutEnd (Ch *)
const Ch *	Peek4 () const

Public Attributes
const Ch *	src_
	Current read position. More...
const Ch *	begin_
	Original head of the string. More...
const Ch *	end_
	End of stream. More...
size_t	size_
	Size of the stream. More...

Detailed Description

Represents an in-memory input byte stream.

This class is mainly for being wrapped by EncodedInputStream or AutoUTFInputStream.

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

Differences between MemoryStream and StringStream:

1. StringStream has encoding but MemoryStream is a byte stream.
2. MemoryStream needs size of the source buffer and the buffer don't need to be null terminated. StringStream assume null-terminated string as source.
3. MemoryStream supports Peek4() for encoding detection. StringStream is specified with an encoding so it should not have Peek4().

   Note

   implements Stream concept

Member Typedef Documentation

typedef char MemoryStream::Ch

Constructor & Destructor Documentation

MemoryStream::MemoryStream ( const Ch *  src, size_t  size  )

inline

: src_(src), begin_(src), end_(src + size), size_(size) {}

Member Function Documentation

void MemoryStream::Flush ( )

inline

{ RAPIDJSON_ASSERT(false); }

Ch MemoryStream::Peek ( ) const

inline

{ return (src_ == end_) ? '\0' : *src_; }

const Ch* MemoryStream::Peek4 ( ) const

inline

 {
 return Tell() + 4 <= size_ ? src_ : 0;
 }

Here is the call graph for this function:

void MemoryStream::Put ( Ch  )

inline

{ RAPIDJSON_ASSERT(false); }

Ch* MemoryStream::PutBegin ( )

inline

{ RAPIDJSON_ASSERT(false); return 0; }

size_t MemoryStream::PutEnd ( Ch *  )

inline

{ RAPIDJSON_ASSERT(false); return 0; }

Ch MemoryStream::Take ( )

inline

{ return (src_ == end_) ? '\0' : *src_++; }

size_t MemoryStream::Tell ( ) const

inline

{ return static_cast<size_t>(src_ - begin_); }

Here is the caller graph for this function:

Member Data Documentation

const Ch* MemoryStream::begin_

Original head of the string.

const Ch* MemoryStream::end_

End of stream.

size_t MemoryStream::size_

Size of the stream.

const Ch* MemoryStream::src_

Current read position.

---

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

• dep/rapidjson/rapidjson/memorystream.h