NCBI C++ ToolKit
Public Types | Public Member Functions | Public Attributes | List of all members
rapidjson::MemoryStream Struct Reference

Search Toolkit Book for rapidjson::MemoryStream

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

#include <misc/jsonwrapp/rapidjson11/memorystream.h>

+ Collaboration diagram for rapidjson::MemoryStream:

Public Types

typedef char Ch
 

Public Member Functions

 MemoryStream (const Ch *src, size_t size)
 
Ch Peek () const
 
Ch Take ()
 
size_t Tell () const
 
ChPutBegin ()
 
void Put (Ch)
 
void Flush ()
 
size_t PutEnd (Ch *)
 
const ChPeek4 () const
 

Public Attributes

const Chsrc_
 Current read position. More...
 
const Chbegin_
 Original head of the string. More...
 
const Chend_
 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

Definition at line 40 of file memorystream.h.

Member Typedef Documentation

◆ Ch

Definition at line 41 of file memorystream.h.

Constructor & Destructor Documentation

◆ MemoryStream()

rapidjson::MemoryStream::MemoryStream ( const Ch src,
size_t  size 
)
inline

Definition at line 43 of file memorystream.h.

Member Function Documentation

◆ Flush()

void rapidjson::MemoryStream::Flush ( void  )
inline

Definition at line 51 of file memorystream.h.

References RAPIDJSON_ASSERT.

◆ Peek()

Ch rapidjson::MemoryStream::Peek ( ) const
inline

Definition at line 45 of file memorystream.h.

References RAPIDJSON_UNLIKELY.

◆ Peek4()

const Ch* rapidjson::MemoryStream::Peek4 ( ) const
inline

Definition at line 55 of file memorystream.h.

◆ Put()

void rapidjson::MemoryStream::Put ( Ch  )
inline

Definition at line 50 of file memorystream.h.

References RAPIDJSON_ASSERT.

◆ PutBegin()

Ch* rapidjson::MemoryStream::PutBegin ( )
inline

Definition at line 49 of file memorystream.h.

References RAPIDJSON_ASSERT.

◆ PutEnd()

size_t rapidjson::MemoryStream::PutEnd ( Ch )
inline

Definition at line 52 of file memorystream.h.

References RAPIDJSON_ASSERT.

◆ Take()

Ch rapidjson::MemoryStream::Take ( )
inline

Definition at line 46 of file memorystream.h.

References RAPIDJSON_UNLIKELY.

◆ Tell()

size_t rapidjson::MemoryStream::Tell ( ) const
inline

Definition at line 47 of file memorystream.h.

Member Data Documentation

◆ begin_

const Ch* rapidjson::MemoryStream::begin_

Original head of the string.

Definition at line 60 of file memorystream.h.

◆ end_

const Ch* rapidjson::MemoryStream::end_

End of stream.

Definition at line 61 of file memorystream.h.

◆ size_

size_t rapidjson::MemoryStream::size_

Size of the stream.

Definition at line 62 of file memorystream.h.

◆ src_

const Ch* rapidjson::MemoryStream::src_

Current read position.

Definition at line 59 of file memorystream.h.


The documentation for this struct was generated from the following file:
Modified on Wed Apr 17 13:09:58 2024 by modify_doxy.py rev. 669887