utils::file::Reader Class Reference

A helper class to read content from a specified input stream. More...

#include "utils/file/reader/Reader.h"

Inheritance diagram for utils::file::Reader:

Collaboration diagram for utils::file::Reader:

Public Member Functions
	Reader ()=default
	~Reader () override=default
	Reader (const Reader &)=delete
Reader &	operator= (const Reader &)=delete
	Reader (Reader &&)=delete
Reader &	operator= (Reader &&)=delete
void	readFromStream (std::istream &stream, std::string &result) const override
	Read content of provided input stream and check errors. More...
Public Member Functions inherited from utils::file::IReader
	IReader ()=default
virtual	~IReader ()=default
	IReader (const IReader &)=delete
IReader &	operator= (const IReader &)=delete
	IReader (IReader &&)=delete
IReader &	operator= (IReader &&)=delete

Detailed Description

A helper class to read content from a specified input stream.

This class is the "low level class" that implements IReader.h

Note

Copy contructor, copy-assignment operator, move constructor and move-assignment operator are defined to be compliant with the "Rule of five"

See also

https://en.cppreference.com/w/cpp/language/rule_of_three

Author

Boubacar DIENE bouba.nosp@m.car..nosp@m.diene.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Date

May 2020

Constructor & Destructor Documentation

Reader() [1/3]

utils::file::Reader::Reader ( )

default

~Reader()

utils::file::Reader::~Reader ( )

overridedefault

Class destructor

Note

The override specifier aims at making the compiler warn if the base class's destructor is not virtual.

Reader() [2/3]

utils::file::Reader::Reader ( const Reader &  )

delete

Class copy constructor

Reader() [3/3]

utils::file::Reader::Reader ( Reader &&  )

delete

Class move constructor

Member Function Documentation

operator=() [1/2]

Reader& utils::file::Reader::operator= ( const Reader &  )

delete

Class copy-assignment operator

operator=() [2/2]

Reader& utils::file::Reader::operator= ( Reader &&  )

delete

Class move-assignment operator

readFromStream()

void utils::file::Reader::readFromStream ( std::istream &  stream, std::string &  result  ) const

overridevirtual

Read content of provided input stream and check errors.

Parameters

stream	The input stream where to get data from
result	The output variable into which store data

Implements utils::file::IReader.

---

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

• /workdir/src/utils/file/reader/Reader.h