StringFileReader Class

Abstract base class for reading file contents into a string. More...

Declaration

class helios::engine::util::io::StringFileReader { ... }

Derived Classes

class	BasicStringFileReader
	Basic implementation of a string file reader. More...

Public Constructors Index

	StringFileReader ()=default

Public Destructor Index

	~StringFileReader ()=default

Public Member Functions Index

std::string	getContents (const std::string &filename) const =0
	Reads the entire contents of the file and returns them as a string. More...
bool	readInto (const std::string &filename, std::string &contents) const noexcept=0
	Attempts to read the entire contents of the file into the provided string. More...

Protected Static Attributes Index

static const helios::engine::util::log::Logger &	logger_ = helios::engine::util::log::LogManager::loggerForScope(HELIOS_LOG_SCOPE)
	Shared logger instance for all StringFileReader objects. More...

Description

Abstract base class for reading file contents into a string.

Definition at line 22 of file StringFileReader.ixx.

Public Constructors

StringFileReader()

helios::engine::util::io::StringFileReader::StringFileReader ()

default

Default constructor.

Definition at line 37 of file StringFileReader.ixx.

Public Destructor

~StringFileReader()

virtual helios::engine::util::io::StringFileReader::~StringFileReader ()

virtual default

Definition at line 32 of file StringFileReader.ixx.

Public Member Functions

getContents()

virtual std::string helios::engine::util::io::StringFileReader::getContents (const std::string & filename)

Reads the entire contents of the file and returns them as a string.

Parameters

filename

The path to the file to read.

Returns

The contents of the file as a std::string. If reading fails, an empty string is returned.

Exceptions

std::runtime_error

if the file operation fails.

Definition at line 47 of file StringFileReader.ixx.

readInto()

virtual bool helios::engine::util::io::StringFileReader::readInto (const std::string & filename, std::string & contents)

noexcept

Attempts to read the entire contents of the file into the provided string.

Parameters

filename	The path to the file to read.
contents	Output parameter receiving the file contents on success.

Returns

true if reading succeeded and contents was populated, otherwise false.

Definition at line 56 of file StringFileReader.ixx.

Protected Static Attributes

logger_

const helios::engine::util::log::Logger& helios::engine::util::io::StringFileReader::logger_ = helios::engine::util::log::LogManager::loggerForScope(HELIOS_LOG_SCOPE)

protected static

Shared logger instance for all StringFileReader objects.

Definition at line 28 of file StringFileReader.ixx.

28 inline static const helios::engine::util::log::Logger& logger_ = helios::engine::util::log::LogManager::loggerForScope(HELIOS_LOG_SCOPE);

Referenced by helios::engine::util::io::BasicStringFileReader::getContents and helios::engine::util::io::BasicStringFileReader::readInto.

---

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

• StringFileReader.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.