libcdoc 0.1.8
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
 
DataConsumeroperator= (const DataConsumer &)=delete
 

Protected Attributes

DataConsumer_dst
 
bool _owned
 

Constructor & Destructor Documentation

◆ ChainedConsumer()

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

◆ ~ChainedConsumer()

libcdoc::ChainedConsumer::~ChainedConsumer ( )
inline

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 libcdoc::OK.

◆ isError()

bool libcdoc::ChainedConsumer::isError ( )
inlineoverridevirtual

checks whether DataSource is in error state

Returns
true if error state

Implements libcdoc::DataConsumer.

◆ 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
srcsource block
sizethe number of bytes to write
Returns
size or error code

Implements libcdoc::DataConsumer.

Member Data Documentation

◆ _dst

DataConsumer* libcdoc::ChainedConsumer::_dst
protected

◆ _owned

bool libcdoc::ChainedConsumer::_owned
protected

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