Provides reading files. More...

#include <ReadFileHandle.h>

Inheritance diagram for file_manager::ReadFileHandle:

Public Member Functions
const std::string &	readAllData ()
	Read all file.

std::streamsize	readSome (std::string &outData, std::streamsize count, bool shrinkOutData=true, bool resizeOutData=true)
	Read some data from file.

std::istream &	getStream ()
	Get reading stream.

Public Member Functions inherited from file_manager::FileHandle
	FileHandle (const FileHandle &)=delete

FileHandle &	operator= (const FileHandle &)=delete

uint64_t	getFileSize () const

const std::filesystem::path &	getPathToFile () const

std::filesystem::path	getFileName () const

Protected Member Functions
	ReadFileHandle (const std::filesystem::path &filePath, std::ios_base::openmode mode=std::ios_base::in)

Protected Member Functions inherited from file_manager::FileHandle
	FileHandle (const std::filesystem::path &filePath, std::ios_base::openmode mode)

	FileHandle (FileHandle &&other) noexcept

FileHandle &	operator= (FileHandle &&other) noexcept

Friends
class	FileManager

Additional Inherited Members
Protected Attributes inherited from file_manager::FileHandle
std::filesystem::path	filePath

std::fstream	file

std::ios_base::openmode	mode

bool	isNotifyOnDestruction

Detailed Description

Provides reading files.

Definition at line 11 of file ReadFileHandle.h.

Constructor & Destructor Documentation

◆ ReadFileHandle()

file_manager::ReadFileHandle::ReadFileHandle	(	const std::filesystem::path &	filePath,
		std::ios_base::openmode	mode = std::ios_base::in )

protected

Definition at line 17 of file ReadFileHandle.cpp.

◆ ~ReadFileHandle()

file_manager::ReadFileHandle::~ReadFileHandle ( )

virtual

Definition at line 71 of file ReadFileHandle.cpp.

Member Function Documentation

◆ getStream()

istream & file_manager::ReadFileHandle::getStream ( )

Get reading stream.

Returns: Input stream

Definition at line 66 of file ReadFileHandle.cpp.

◆ readAllData()

const string & file_manager::ReadFileHandle::readAllData ( )

Read all file.

Returns: File's data

Exceptions

FileDoesNotExistException

Definition at line 30 of file ReadFileHandle.cpp.

◆ readSome()

streamsize file_manager::ReadFileHandle::readSome	(	std::string &	outData,
		std::streamsize	count,
		bool	shrinkOutData = true,
		bool	resizeOutData = true )

Read some data from file.

Parameters

outData	Data from file
count	Count of characters to read
shrinkOutData	If true outData will be shrinked
resizeOutData	If true outData will be resized to count size. If false you must provide outData size before calling

Returns: Number of characters read

Definition at line 49 of file ReadFileHandle.cpp.

Friends And Related Symbol Documentation

◆ FileManager

friend class FileManager

friend

Definition at line 47 of file ReadFileHandle.h.

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

src/Handlers/ReadFileHandle.h
src/Handlers/ReadFileHandle.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members