libcdoc::ChainedConsumer Struct Reference

#include <Io.h>

Inherits libcdoc::DataConsumer.

Public Member Functions
	ChainedConsumer (DataConsumer *dst, bool take_ownership)
	~ChainedConsumer ()
result_t	write (const uint8_t *src, size_t size) override
	write write bytes to output object
result_t	close () override
	informs DataConsumer that the writing is finished
bool	isError () override
	checks whether DataSource is in error state
Public Member Functions inherited from libcdoc::DataConsumer
	DataConsumer ()=default
virtual	~DataConsumer ()=default
virtual std::string	getLastErrorStr (result_t code) const
	get textual description of the last error
result_t	write (const std::vector< uint8_t > &src)
	write all bytes in vector
result_t	write (const std::string &src)
	write all bytes in string
result_t	writeAll (DataSource &src)
	write all data from input object
	DataConsumer (const DataConsumer &)=delete
DataConsumer &	operator= (const DataConsumer &)=delete

Protected Attributes
DataConsumer *	_dst
bool	_owned

Constructor & Destructor Documentation

ChainedConsumer()

libcdoc::ChainedConsumer::ChainedConsumer ( DataConsumer * dst, bool take_ownership )

inline

References _dst, _owned, and libcdoc::DataConsumer::DataConsumer().

~ChainedConsumer()

libcdoc::ChainedConsumer::~ChainedConsumer ( )

inline

References _dst, and _owned.

Member Function Documentation

close()

result_t libcdoc::ChainedConsumer::close ( )

inlineoverridevirtual

informs DataConsumer that the writing is finished

Returns

error code or OK

Implements libcdoc::DataConsumer.

References _dst, _owned, and libcdoc::OK.

isError()

bool libcdoc::ChainedConsumer::isError ( )

inlineoverridevirtual

checks whether DataSource is in error state

Returns

true if error state

Implements libcdoc::DataConsumer.

References _dst.

write()

result_t libcdoc::ChainedConsumer::write ( const uint8_t * src, size_t size )

inlineoverridevirtual

write write bytes to output object

The following invariant holds: If there was no error then result == size If there was an error then result < 0

Parameters

src	source block
size	the number of bytes to write

Returns

size or error code

Implements libcdoc::DataConsumer.

References _dst.

Member Data Documentation

_dst

DataConsumer* libcdoc::ChainedConsumer::_dst

protected

Referenced by ChainedConsumer(), close(), isError(), write(), and ~ChainedConsumer().

_owned

bool libcdoc::ChainedConsumer::_owned

protected

Referenced by ChainedConsumer(), close(), and ~ChainedConsumer().

---

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

• Io.h