filesystem Namespace Reference

Classes
class	FileSystemError

Functions
bool	existFile (const std::string &path)
bool	existDirectory (const std::string &path)
bool	existDirectory (const std::string &parentDirectory, const std::string &name)
void	listDirectory (const std::string &path, std::vector< std::string > &entries)
void	createDirectory (const std::string &path)
void	createDirectory (const std::string &parentDirectory, const std::string &name)
void	removeDirectory (const std::string &path)
void	renameDirectory (const std::string &path, const std::string &newPath)
long long	getFileSize (const std::string &path)
std::string	getCurrentDirectory ()
bool	isAbsolutePath (const std::string &path)

Detailed Description

A namespace with filesystem utility functions.

Function Documentation

void filesystem::createDirectory

(

const std::string &

path

)

Create a directory in the given absolute path.

Parameters

path	An absolute directory path.

Exceptions

FileSystemError

if the operation has failed.

void filesystem::createDirectory	(	const std::string &	parentDirectory,
		const std::string &	name
	)

Create a directory in the given parent directory.

Parameters

parentDirectory	The absolue path of a parent directory.
name	A name for the new directory.

Exceptions

FileSystemError

if the operation has failed.

bool filesystem::existDirectory

(

const std::string &

path

)

Parameters

path	The path of a certain directory.

Returns

true if the directory exists, false if it doesn't or if there is an error.

bool filesystem::existDirectory	(	const std::string &	parentDirectory,
		const std::string &	name
	)

Parameters

parentDirectory	The path of a certain directory.
name	The name of a certain directory.

Returns

true if <name> exists as child of <parentDirectory>, false if it doesn't or if there is an error.

bool filesystem::existFile

(

const std::string &

path

)

Max size allowed for an absolute path.

Parameters

path	The path of a certain file.

Returns

true if the file exists, false if it doesn't or if there is an error.

string filesystem::getCurrentDirectory

(

)

Returns

String with the Current Working Director (CWD) of the calling process, as an absolute path.

Exceptions

FileSystemError

if the operation has failed.

long long filesystem::getFileSize

(

const std::string &

path

)

Parameters

path	An absolute file path.

Returns

The size of the given file (a 64 bit integer).

Exceptions

FileSystemError

if the operation has failed.

bool filesystem::isAbsolutePath

(

const std::string &

path

)

Parameters

path	A path of a file or a directory.

Returns

true if the given path is an absolute path, false otherwise.

void filesystem::listDirectory	(	const std::string &	path,
		std::vector< std::string > &	entries
	)

List a given directory.

Parameters

path	The path of a certain directory.
entries	A string vector to store the directory content.

Exceptions

FileSystemError

if the operation has failed.

void filesystem::removeDirectory

(

const std::string &

path

)

Remove the given absolute directory path.

Parameters

path	An absolute directory path.

Exceptions

FileSystemError

if the operation has failed.

void filesystem::renameDirectory	(	const std::string &	path,
		const std::string &	newPath
	)

Rename the given absolute directory path.

Parameters

newPath

The new name for the directory.

Exceptions

FileSystemError

if the operation has failed.