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

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

#include <toolbox/util/Stream.hpp>

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

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

Public Member Functions
	OStream (std::nullptr_t) noexcept
	Constructor for initialising the StreamBuf with a null buffer.
	OStream ()
	~OStream () override=default
	OStream (const OStream &)=delete
OStream &	operator= (const OStream &)=delete
	OStream (OStream &&)=delete
OStream &	operator= (OStream &&)=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 and clear i/o state.
void	reset () noexcept
	Reset the current position back to the beginning of the buffer and clear i/o state.

Static Public Member Functions
static StoragePtr< MaxN >	make_storage ()

Detailed Description

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

OStream uses a dynamic storage acquired from the custom allocator.

Definition at line 98 of file Stream.hpp.

Constructor & Destructor Documentation

OStream() [1/4]

template<std::size_t MaxN>

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

inlineexplicitnoexcept

Constructor for initialising the StreamBuf with a null buffer.

Definition at line 101 of file Stream.hpp.

OStream() [2/4]

template<std::size_t MaxN>

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

inline

Definition at line 107 of file Stream.hpp.

~OStream()

template<std::size_t MaxN>

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

overridedefault

OStream() [3/4]

template<std::size_t MaxN>

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

delete

OStream() [4/4]

template<std::size_t MaxN>

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

delete

Member Function Documentation

operator=() [1/2]

template<std::size_t MaxN>

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

delete

operator=() [2/2]

template<std::size_t MaxN>

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

delete

make_storage()

template<std::size_t MaxN>

static StoragePtr< MaxN > toolbox::util::OStream< MaxN >::make_storage ( )

inlinestatic

Definition at line 122 of file Stream.hpp.

data()

template<std::size_t MaxN>

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

inlinenoexcept

Definition at line 123 of file Stream.hpp.

empty()

template<std::size_t MaxN>

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

inlinenoexcept

Definition at line 124 of file Stream.hpp.

size()

template<std::size_t MaxN>

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

inlinenoexcept

Definition at line 125 of file Stream.hpp.

release_storage()

template<std::size_t MaxN>

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

inlinenoexcept

Release the managed storage.

Definition at line 128 of file Stream.hpp.

set_storage()

template<std::size_t MaxN>

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

inlinenoexcept

Update the internal storage and clear i/o state.

Definition at line 130 of file Stream.hpp.

reset()

template<std::size_t MaxN>

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

inlinenoexcept

Reset the current position back to the beginning of the buffer and clear i/o state.

Definition at line 136 of file Stream.hpp.

---

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

• toolbox/util/Stream.hpp