file_handler Namespace Reference

Responsible for file handling functions. More...

Functions
std::string	get_parent_directory (const std::string &path)
	Get the parent directory of a file or directory.
bool	make_directory (const std::string &path)
	Make a directory.
std::string	read_file (const char *path)
	Read a file to string.
int	write_file (const char *path, const std::string_view &contents)
	Writes a file.

Detailed Description

Responsible for file handling functions.

Function Documentation

get_parent_directory()

std::string file_handler::get_parent_directory

(

const std::string &

path

)

Get the parent directory of a file or directory.

Parameters

path	The path of the file or directory.

Returns

The parent directory.

Examples

std::string parent_dir = get_parent_directory("path/to/file");

make_directory()

bool file_handler::make_directory

(

const std::string &

path

)

Make a directory.

Parameters

path	The path of the directory.

Returns

true on success, false on failure.

Examples

bool dir_created = make_directory("path/to/directory");

read_file()

std::string file_handler::read_file

(

const char *

path

)

Read a file to string.

Parameters

path	The path of the file.

Returns

The contents of the file.

Examples

std::string contents = read_file("path/to/file");

write_file()

int file_handler::write_file	(	const char *	path,
		const std::string_view &	contents )

Writes a file.

Parameters

path	The path of the file.
contents	The contents to write.

Returns

0 on success, -1 on failure.

Examples

int write_status = write_file("path/to/file", "file contents");