networkservice
Public Member Functions | List of all members
utils::file::Writer Class Reference

A helper class to write a given value to a specified file. More...

#include "utils/file/writer/Writer.h"

Inheritance diagram for utils::file::Writer:
Inheritance graph
[legend]
Collaboration diagram for utils::file::Writer:
Collaboration graph
[legend]

Public Member Functions

 Writer ()=default
 
 ~Writer () override=default
 
 Writer (const Writer &)=delete
 
Writeroperator= (const Writer &)=delete
 
 Writer (Writer &&)=delete
 
Writeroperator= (Writer &&)=delete
 
void writeToStream (std::ostream &stream, const std::string &value) const override
 Write the given value to the provided output stream and check errors. More...
 
- Public Member Functions inherited from utils::file::IWriter
 IWriter ()=default
 
virtual ~IWriter ()=default
 
 IWriter (const IWriter &)=delete
 
IWriteroperator= (const IWriter &)=delete
 
 IWriter (IWriter &&)=delete
 
IWriteroperator= (IWriter &&)=delete
 

Detailed Description

A helper class to write a given value to a specified file.

This class is the "low level class" that implements IWriter.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
April 2020

Constructor & Destructor Documentation

◆ Writer() [1/3]

utils::file::Writer::Writer ( )
default

◆ ~Writer()

utils::file::Writer::~Writer ( )
overridedefault

Class destructor

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

◆ Writer() [2/3]

utils::file::Writer::Writer ( const Writer )
delete

Class copy constructor

◆ Writer() [3/3]

utils::file::Writer::Writer ( Writer &&  )
delete

Class move constructor

Member Function Documentation

◆ operator=() [1/2]

Writer& utils::file::Writer::operator= ( const Writer )
delete

Class copy-assignment operator

◆ operator=() [2/2]

Writer& utils::file::Writer::operator= ( Writer &&  )
delete

Class move-assignment operator

◆ writeToStream()

void utils::file::Writer::writeToStream ( std::ostream &  stream,
const std::string &  value 
) const
overridevirtual

Write the given value to the provided output stream and check errors.

Parameters
streamThe output stream where to write the value
valueThe new value that will replace the currrent content

Implements utils::file::IWriter.


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