libcdoc::VectorConsumer Struct Reference

#include <Io.h>

Inherits libcdoc::DataConsumer.

Public Member Functions
	VectorConsumer (std::vector< uint8_t > &data)
result_t	write (const uint8_t *src, size_t size) noexcept final
	write write bytes to output object
result_t	close () noexcept final
	informs DataConsumer that the writing is finished
bool	isError () noexcept final
	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) noexcept
	write all bytes in vector
result_t	write (const std::string &src) noexcept
	write all bytes in string
result_t	writeAll (DataSource &src) noexcept
	write all data from input object
	DataConsumer (const DataConsumer &)=delete
DataConsumer &	operator= (const DataConsumer &)=delete

Protected Attributes
std::vector< uint8_t > &	_data

Constructor & Destructor Documentation

VectorConsumer()

libcdoc::VectorConsumer::VectorConsumer ( std::vector< uint8_t > & data )

inline

References _data.

Member Function Documentation

close()

result_t libcdoc::VectorConsumer::close ( )

inlinefinalvirtualnoexcept

informs DataConsumer that the writing is finished

Returns

error code or OK

Implements libcdoc::DataConsumer.

References libcdoc::OK.

isError()

bool libcdoc::VectorConsumer::isError ( )

inlinefinalvirtualnoexcept

checks whether DataSource is in error state

Returns

true if error state

Implements libcdoc::DataConsumer.

write()

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

inlinefinalvirtualnoexcept

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 _data.

Member Data Documentation

_data

std::vector<uint8_t>& libcdoc::VectorConsumer::_data

protected

Referenced by VectorConsumer(), and write().

---

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

• Io.h