toolbox::util::StreamBuf< MaxN > Class Template Reference

StreamBuf uses a dynamic storage acquired from the custom allocator. More...

#include <toolbox/util/Stream.hpp>

Inheritance diagram for toolbox::util::StreamBuf< MaxN >:

Collaboration diagram for toolbox::util::StreamBuf< MaxN >:

Public Member Functions
	StreamBuf (std::nullptr_t) noexcept
	Constructor for initialising the StreamBuf with a null buffer.
	StreamBuf ()
	~StreamBuf () override=default
	StreamBuf (const StreamBuf &)=delete
StreamBuf &	operator= (const StreamBuf &)=delete
	StreamBuf (StreamBuf &&)=delete
StreamBuf &	operator= (StreamBuf &&)=delete
const char *	data () const noexcept
bool	empty () const noexcept
std::size_t	size () const noexcept
StoragePtr< MaxN >	release_storage () noexcept
	Release the managed storage.
void	set_storage (StoragePtr< MaxN > storage) noexcept
	Update the internal storage.
void	reset () noexcept
	Reset the current position back to the beginning of the buffer.

Detailed Description

template<std::size_t MaxN>
class toolbox::util::StreamBuf< MaxN >

StreamBuf uses a dynamic storage acquired from the custom allocator.

Definition at line 40 of file Stream.hpp.

Constructor & Destructor Documentation

StreamBuf() [1/4]

template<std::size_t MaxN>

toolbox::util::StreamBuf< MaxN >::StreamBuf ( std::nullptr_t  )

inlineexplicitnoexcept

Constructor for initialising the StreamBuf with a null buffer.

Definition at line 43 of file Stream.hpp.

StreamBuf() [2/4]

template<std::size_t MaxN>

toolbox::util::StreamBuf< MaxN >::StreamBuf ( )

inline

Definition at line 44 of file Stream.hpp.

~StreamBuf()

template<std::size_t MaxN>

toolbox::util::StreamBuf< MaxN >::~StreamBuf ( )

overridedefault

StreamBuf() [3/4]

template<std::size_t MaxN>

toolbox::util::StreamBuf< MaxN >::StreamBuf ( const StreamBuf< MaxN > &  )

delete

StreamBuf() [4/4]

template<std::size_t MaxN>

toolbox::util::StreamBuf< MaxN >::StreamBuf ( StreamBuf< MaxN > &&  )

delete

Member Function Documentation

operator=() [1/2]

template<std::size_t MaxN>

StreamBuf & toolbox::util::StreamBuf< MaxN >::operator= ( const StreamBuf< MaxN > &  )

delete

operator=() [2/2]

template<std::size_t MaxN>

StreamBuf & toolbox::util::StreamBuf< MaxN >::operator= ( StreamBuf< MaxN > &&  )

delete

data()

template<std::size_t MaxN>

const char * toolbox::util::StreamBuf< MaxN >::data ( ) const

inlinenoexcept

Definition at line 59 of file Stream.hpp.

empty()

template<std::size_t MaxN>

bool toolbox::util::StreamBuf< MaxN >::empty ( ) const

inlinenoexcept

Definition at line 60 of file Stream.hpp.

size()

template<std::size_t MaxN>

std::size_t toolbox::util::StreamBuf< MaxN >::size ( ) const

inlinenoexcept

Definition at line 61 of file Stream.hpp.

release_storage()

template<std::size_t MaxN>

StoragePtr< MaxN > toolbox::util::StreamBuf< MaxN >::release_storage ( )

inlinenoexcept

Release the managed storage.

Definition at line 64 of file Stream.hpp.

set_storage()

template<std::size_t MaxN>

void toolbox::util::StreamBuf< MaxN >::set_storage ( StoragePtr< MaxN >  storage )

inlinenoexcept

Update the internal storage.

Definition at line 72 of file Stream.hpp.

reset()

template<std::size_t MaxN>

void toolbox::util::StreamBuf< MaxN >::reset ( )

inlinenoexcept

Reset the current position back to the beginning of the buffer.

Definition at line 74 of file Stream.hpp.

---

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

• toolbox/util/Stream.hpp