active::utility::StackBufferOut< S > Class Template Reference

Inheritance diagram for active::utility::StackBufferOut< S >:

Collaboration diagram for active::utility::StackBufferOut< S >:

Public Member Functions
	StackBufferOut ()
	StackBufferOut (file::File &destFile)
	StackBufferOut (Memory &memory)
	StackBufferOut (String &destString)
	StackBufferOut (BufferOut &&source) noexcept=delete
	StackBufferOut (const BufferOut &source)=delete
StackBufferOut &	operator= (BufferOut &&source) noexcept=delete
StackBufferOut &	operator= (const BufferOut &)=delete
Public Member Functions inherited from active::utility::BufferOut
	BufferOut ()
	BufferOut (file::File &destFile, Memory::sizeOption bufferSize=std::nullopt, DataFormat format=DataFormat{})
	BufferOut (Memory &memory, Memory::sizeOption bufferSize=std::nullopt, DataFormat format=DataFormat{})
	BufferOut (Memory &&memory, Memory::sizeOption bufferSize=std::nullopt, DataFormat format=DataFormat{})
	BufferOut (String &destString, Memory::sizeOption bufferSize=std::nullopt, DataFormat format=DataFormat{})
	BufferOut (BufferOut &&source) noexcept
	BufferOut (const BufferOut &source)=delete
virtual	~BufferOut ()
BufferOut &	operator= (BufferOut &&source) noexcept
BufferOut &	operator= (const BufferOut &)=delete
	operator bool () const
const BufferOut &	operator<< (char val) const
const BufferOut &	operator<< (const String &str) const
const BufferOut &	operator<< (int16_t val) const
const BufferOut &	operator<< (int32_t val) const
const BufferOut &	operator<< (uint32_t val) const
const BufferOut &	operator<< (int64_t val) const
const BufferOut &	operator<< (uint64_t val) const
const BufferOut &	operator<< (double val) const
Memory::sizeOption	maxSize () const
Memory::sizeOption	getPosition () const
DataFormat	format () const
TextEncoding	getEncoding () const
const BufferOut &	write (const String &toWrite) const
const BufferOut &	write (const String &toWrite, DataFormat format) const
const BufferOut &	write (const char *toWrite, Memory::size_type length) const
const BufferOut &	write (unsigned char toWrite) const
template<class T >
const BufferOut &	writeBinary (const T &obj) const
const BufferOut &	flush () const
void	setDestination (file::File *destFile)
void	setDestination (Memory *memory)
void	setDestination (String *destString)
void	setEncoding (TextEncoding encoding)
Public Member Functions inherited from active::file::IOBase
	IOBase () noexcept
	IOBase (const IOBase &source) noexcept
virtual	~IOBase () noexcept=default
bool	operator! () const noexcept
	operator void * () const noexcept
virtual bool	good () const noexcept
virtual bool	eof () const noexcept
virtual bool	fail () const noexcept
virtual bool	bad () const noexcept
virtual flag_type	state () const noexcept
virtual void	clear (flag_type f=std::ios_base::goodbit)
virtual void	setState (flag_type f)
virtual void	unsetState (flag_type f)

Protected Member Functions
virtual bool	isMyBuffer () const override
virtual bool	confirmBuffer () const override
Protected Member Functions inherited from active::utility::BufferOut
const Memory &	getBuffer () const
void	setBuffer (void *buffer, Memory::size_type size) const
Protected Member Functions inherited from active::file::IOBase
void	setCompleteState (flag_type state)
void	clear (flag_type f=std::ios_base::goodbit) const
void	setState (flag_type f) const
virtual void	unsetState (flag_type f) const

Additional Inherited Members
Public Types inherited from active::file::IOBase
using	flag_type = std::ios_base::iostate
	The state flag representation type.

Constructor & Destructor Documentation

StackBufferOut() [1/4]

template<size_t S>

active::utility::StackBufferOut< S >::StackBufferOut ( )

inline

Default constructor

StackBufferOut() [2/4]

template<size_t S>

active::utility::StackBufferOut< S >::StackBufferOut ( file::File & destFile )

inline

Constructor

Parameters

destFile

The destination data file

StackBufferOut() [3/4]

template<size_t S>

active::utility::StackBufferOut< S >::StackBufferOut ( Memory & memory )

inline

Constructor

Parameters

memory

The destination memory block

StackBufferOut() [4/4]

template<size_t S>

active::utility::StackBufferOut< S >::StackBufferOut ( String & destString )

inline

Constructor

Parameters

destString

The destination string

Member Function Documentation

confirmBuffer()

template<size_t S>

virtual bool active::utility::StackBufferOut< S >::confirmBuffer ( ) const

inlineoverrideprotectedvirtual

Confirm the buffer is mine and prepared to receive data

Returns

True if the buffer is confirmed (false = bad buffer state - writing will be rejected)

Reimplemented from active::utility::BufferOut.

Here is the call graph for this function:

isMyBuffer()

template<size_t S>

virtual bool active::utility::StackBufferOut< S >::isMyBuffer ( ) const

inlineoverrideprotectedvirtual

Determine is the buffer is owned by this object

Returns

True if this object owns the buffer

Reimplemented from active::utility::BufferOut.

---

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

• /Users/rwessel/Documents/Development/ActiveLib/Active/Utility/StackBufferOut.h