InspIRCd  2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations
Public Member Functions | List of all members
FileReader Class Reference

#include <modules.h>

Inheritance diagram for FileReader:

Public Member Functions

 FileReader ()
 FileReader (const std::string &filename)
 ~FileReader ()
void LoadFile (const std::string &filename)
std::string Contents ()
unsigned long ContentSize ()
bool Exists ()
std::string GetLine (int x)
int FileSize ()
- Public Member Functions inherited from classbase
virtual CullResult cull ()

Detailed Description

Caches a text file into memory and can be used to retrieve lines from it. This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file.

Constructor & Destructor Documentation

FileReader::FileReader ( )

Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.

FileReader::FileReader ( const std::string &  filename)

Secondary constructor. This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

FileReader::~FileReader ( )

Default destructor. This deletes the memory allocated to the file.

Member Function Documentation

std::string FileReader::Contents ( )

Returns the whole content of the file as std::string

unsigned long FileReader::ContentSize ( )

Returns the entire size of the file as std::string

bool FileReader::Exists ( )

Returns true if the file exists This function will return false if the file could not be opened.

int FileReader::FileSize ( )

Returns the size of the file in lines. This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.

std::string FileReader::GetLine ( int  x)

Retrieve one line from the file. This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.

void FileReader::LoadFile ( const std::string &  filename)

Used to load a file. This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

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