Double ended buffer combining vector and stream-like interfaces. More...

#include <streams.h>

Public Types
typedef vector_type::allocator_type	allocator_type

typedef vector_type::size_type	size_type

typedef vector_type::difference_type	difference_type

typedef vector_type::reference	reference

typedef vector_type::const_reference	const_reference

typedef vector_type::value_type	value_type

typedef vector_type::iterator	iterator

typedef vector_type::const_iterator	const_iterator

typedef vector_type::reverse_iterator	reverse_iterator

Public Member Functions
	CDataStream (int nTypeIn, int nVersionIn)

	CDataStream (Span< const uint8_t > sp, int nTypeIn, int nVersionIn)

template<typename... Args>
	CDataStream (int nTypeIn, int nVersionIn, Args &&... args)

std::string	str () const

const_iterator	begin () const

iterator	begin ()

const_iterator	end () const

iterator	end ()

size_type	size () const

bool	empty () const

void	resize (size_type n, value_type c=0)

void	reserve (size_type n)

const_reference	operator[] (size_type pos) const

reference	operator[] (size_type pos)

void	clear ()

iterator	insert (iterator it, const uint8_t x)

void	insert (iterator it, size_type n, const uint8_t x)

value_type *	data ()

const value_type *	data () const

void	insert (iterator it, std::vector< uint8_t >::const_iterator first, std::vector< uint8_t >::const_iterator last)

void	insert (iterator it, const char first, const char last)

iterator	erase (iterator it)

iterator	erase (iterator first, iterator last)

void	Compact ()

bool	Rewind (std::optional< size_type > n=std::nullopt)

bool	eof () const

CDataStream *	rdbuf ()

int	in_avail () const

void	SetType (int n)

int	GetType () const

void	SetVersion (int n)

int	GetVersion () const

void	read (char *pch, size_t nSize)

void	ignore (int nSize)

void	write (const char *pch, size_t nSize)

template<typename Stream >
void	Serialize (Stream &s) const

template<typename T >
CDataStream &	operator<< (const T &obj)

template<typename T >
CDataStream &	operator>> (T &&obj)

void	Xor (const std::vector< unsigned char > &key)
	XOR the contents of this stream with a certain key. More...

Protected Types
using	vector_type = SerializeData

Protected Attributes
vector_type	vch

unsigned int	nReadPos {0}

int	nType

int	nVersion

Detailed Description

Double ended buffer combining vector and stream-like interfaces.

and << read and write unformatted data using the above serialization templates.

Fills with data in linear time; some stringstream implementations take N^2 time.

Definition at line 204 of file streams.h.

Member Typedef Documentation

◆ allocator_type

typedef vector_type::allocator_type CDataStream::allocator_type

Definition at line 215 of file streams.h.

◆ const_iterator

typedef vector_type::const_iterator CDataStream::const_iterator

Definition at line 222 of file streams.h.

◆ const_reference

typedef vector_type::const_reference CDataStream::const_reference

Definition at line 219 of file streams.h.

◆ difference_type

typedef vector_type::difference_type CDataStream::difference_type

Definition at line 217 of file streams.h.

◆ iterator

typedef vector_type::iterator CDataStream::iterator

Definition at line 221 of file streams.h.

◆ reference

typedef vector_type::reference CDataStream::reference

Definition at line 218 of file streams.h.

◆ reverse_iterator

typedef vector_type::reverse_iterator CDataStream::reverse_iterator

Definition at line 223 of file streams.h.

◆ size_type

typedef vector_type::size_type CDataStream::size_type

Definition at line 216 of file streams.h.

◆ value_type

typedef vector_type::value_type CDataStream::value_type

Definition at line 220 of file streams.h.

◆ vector_type

using CDataStream::vector_type = SerializeData

protected

Definition at line 207 of file streams.h.

Constructor & Destructor Documentation

◆ CDataStream() [1/3]

CDataStream::CDataStream	(	int	nTypeIn,
		int	nVersionIn
	)

inlineexplicit

Definition at line 225 of file streams.h.

◆ CDataStream() [2/3]

CDataStream::CDataStream	(	Span< const uint8_t >	sp,
		int	nTypeIn,
		int	nVersionIn
	)

inlineexplicit

Definition at line 229 of file streams.h.

◆ CDataStream() [3/3]

template<typename... Args>

CDataStream::CDataStream	(	int	nTypeIn,
		int	nVersionIn,
		Args &&...	args
	)

inline

Definition at line 235 of file streams.h.

Here is the call graph for this function:

Member Function Documentation

◆ begin() [1/2]

iterator CDataStream::begin ( )

inline

Definition at line 252 of file streams.h.

◆ begin() [2/2]

const_iterator CDataStream::begin ( ) const

inline

Definition at line 251 of file streams.h.

Here is the caller graph for this function:

◆ clear()

void CDataStream::clear ( )

inline

Definition at line 261 of file streams.h.

Here is the caller graph for this function:

◆ Compact()

void CDataStream::Compact ( )

inline

Definition at line 332 of file streams.h.

◆ data() [1/2]

value_type * CDataStream::data ( )

inline

Definition at line 264 of file streams.h.

Here is the caller graph for this function:

◆ data() [2/2]

const value_type * CDataStream::data ( ) const

inline

Definition at line 265 of file streams.h.

◆ empty()

bool CDataStream::empty ( ) const

inline

Definition at line 256 of file streams.h.

Here is the caller graph for this function:

◆ end() [1/2]

iterator CDataStream::end ( )

inline

Definition at line 254 of file streams.h.

◆ end() [2/2]

const_iterator CDataStream::end ( ) const

inline

Definition at line 253 of file streams.h.

Here is the caller graph for this function:

◆ eof()

bool CDataStream::eof ( ) const

inline

Definition at line 356 of file streams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ erase() [1/2]

iterator CDataStream::erase	(	iterator	first,
		iterator	last
	)

inline

Definition at line 312 of file streams.h.

◆ erase() [2/2]

iterator CDataStream::erase ( iterator it )

inline

Definition at line 295 of file streams.h.

Here is the caller graph for this function:

◆ GetType()

int CDataStream::GetType ( ) const

inline

Definition at line 361 of file streams.h.

◆ GetVersion()

int CDataStream::GetVersion ( ) const

inline

Definition at line 363 of file streams.h.

Here is the caller graph for this function:

◆ ignore()

void CDataStream::ignore ( int nSize )

inline

Definition at line 384 of file streams.h.

◆ in_avail()

int CDataStream::in_avail ( ) const

inline

Definition at line 358 of file streams.h.

Here is the call graph for this function:

◆ insert() [1/4]

void CDataStream::insert	(	iterator	it,
		const char *	first,
		const char *	last
	)

inline

Definition at line 281 of file streams.h.

Here is the call graph for this function:

◆ insert() [2/4]

iterator CDataStream::insert	(	iterator	it,
		const uint8_t	x
	)

inline

Definition at line 262 of file streams.h.

Here is the caller graph for this function:

◆ insert() [3/4]

void CDataStream::insert	(	iterator	it,
		size_type	n,
		const uint8_t	x
	)

inline

Definition at line 263 of file streams.h.

◆ insert() [4/4]

void CDataStream::insert	(	iterator	it,
		std::vector< uint8_t >::const_iterator	first,
		std::vector< uint8_t >::const_iterator	last
	)

inline

Definition at line 267 of file streams.h.

Here is the call graph for this function:

◆ operator<<()

template<typename T >

CDataStream & CDataStream::operator<< ( const T & obj )

inline

Definition at line 417 of file streams.h.

Here is the call graph for this function:

◆ operator>>()

template<typename T >

CDataStream & CDataStream::operator>> ( T && obj )

inline

Definition at line 425 of file streams.h.

Here is the call graph for this function:

◆ operator[]() [1/2]

reference CDataStream::operator[] ( size_type pos )

inline

Definition at line 260 of file streams.h.

◆ operator[]() [2/2]

const_reference CDataStream::operator[] ( size_type pos ) const

inline

Definition at line 259 of file streams.h.

◆ rdbuf()

CDataStream * CDataStream::rdbuf ( )

inline

Definition at line 357 of file streams.h.

◆ read()

void CDataStream::read	(	char *	pch,
		size_t	nSize
	)

inline

Definition at line 365 of file streams.h.

◆ reserve()

void CDataStream::reserve ( size_type n )

inline

Definition at line 258 of file streams.h.

Here is the caller graph for this function:

◆ resize()

void CDataStream::resize	(	size_type	n,
		value_type	c = `0`
	)

inline

Definition at line 257 of file streams.h.

Here is the caller graph for this function:

◆ Rewind()

bool CDataStream::Rewind ( std::optional< size_type > n = std::nullopt )

inline

Definition at line 338 of file streams.h.

Here is the caller graph for this function:

◆ Serialize()

template<typename Stream >

void CDataStream::Serialize ( Stream & s ) const

inline

Definition at line 409 of file streams.h.

Here is the caller graph for this function:

◆ SetType()

void CDataStream::SetType ( int n )

inline

Definition at line 360 of file streams.h.

Here is the caller graph for this function:

◆ SetVersion()

void CDataStream::SetVersion ( int n )

inline

Definition at line 362 of file streams.h.

Here is the caller graph for this function:

◆ size()

size_type CDataStream::size ( ) const

inline

Definition at line 255 of file streams.h.

Here is the caller graph for this function:

◆ str()

std::string CDataStream::str ( ) const

inline

Definition at line 242 of file streams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void CDataStream::write	(	const char *	pch,
		size_t	nSize
	)

inline

Definition at line 402 of file streams.h.

Here is the caller graph for this function:

◆ Xor()

void CDataStream::Xor ( const std::vector< unsigned char > & key )

inline

XOR the contents of this stream with a certain key.

Parameters

[in] key The key used to XOR the data in this stream.

Definition at line 437 of file streams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ nReadPos

unsigned int CDataStream::nReadPos {0}

protected

Definition at line 209 of file streams.h.

◆ nType

int CDataStream::nType

protected

Definition at line 211 of file streams.h.

◆ nVersion

int CDataStream::nVersion

protected

Definition at line 212 of file streams.h.

◆ vch

vector_type CDataStream::vch

protected

Definition at line 208 of file streams.h.

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

src/streams.h

Public Types

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ const_iterator

◆ const_reference

◆ difference_type

◆ iterator

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

◆ vector_type

Constructor & Destructor Documentation

◆ CDataStream() [1/3]

◆ CDataStream() [2/3]

◆ CDataStream() [3/3]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ Compact()

◆ data() [1/2]

◆ data() [2/2]

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ eof()

◆ erase() [1/2]

◆ erase() [2/2]

◆ GetType()

◆ GetVersion()

◆ ignore()

◆ in_avail()

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ operator<<()

◆ operator>>()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ rdbuf()

◆ read()

◆ reserve()

◆ resize()

◆ Rewind()

◆ Serialize()

◆ SetType()

◆ SetVersion()

◆ size()

◆ str()

◆ write()

◆ Xor()

Member Data Documentation

◆ nReadPos

◆ nType

◆ nVersion

◆ vch