ldvc_io.hpp File Reference

Provides utilities for file input/output operations in C++. More...

#include <fstream>
#include <string>
#include <stdexcept>
#include <sys/stat.h>
#include <ldvc_type.hpp>

Include dependency graph for ldvc_io.hpp:

Go to the source code of this file.

Functions
template<typename T >
void	ldvc_write_file (const string &filename, const T &data)
	Writes data to a file.
template<typename T >
T	ldvc_read_file (const string &filename)
	Reads data from a file.
bool	ldvc_file_exists (const string &folder_path)
	Checks if a file exists.
bool	ldvc_create_folder (const string &folder_path, u16 mode)
	Creates a folder with the specified permissions.
bool	ldvc_delete_file (string file_path)
	Deletes a file specified by its path.
bool	ldvc_delete_folder (string folder_path)
	Deletes a folder specified by its path.

Detailed Description

Provides utilities for file input/output operations in C++.

This header file defines functions for performing file input/output operations in C++, including writing data to a file, reading data from a file, checking file existence, and creating folders.

Author

Nathanne Isip

Definition in file ldvc_io.hpp.

Function Documentation

ldvc_create_folder()

bool ldvc_create_folder	(	const string &	folder_path,
		u16	mode )

Creates a folder with the specified permissions.

This function creates a folder at the specified path with the given permissions.

Parameters

folder_path	The path of the folder to create.
mode	The permissions for the folder.

Returns

bool True if the folder was created successfully, false otherwise.

ldvc_delete_file()

bool ldvc_delete_file

(

string

file_path

)

Deletes a file specified by its path.

This function deletes the file located at the specified file path.

Parameters

file_path

The path to the file to be deleted.

Returns

true if the file is successfully deleted, false otherwise.

ldvc_delete_folder()

bool ldvc_delete_folder

(

string

folder_path

)

Deletes a folder specified by its path.

This function deletes the folder located at the specified folder path.

Parameters

folder_path

The path to the folder to be deleted.

Returns

true if the folder is successfully deleted, false otherwise.

ldvc_file_exists()

bool ldvc_file_exists

(

const string &

folder_path

)

Checks if a file exists.

This function checks if a file exists at the specified path.

Parameters

filename

The filename or path of the file to check.

Returns

bool True if the file exists, false otherwise.

ldvc_read_file()

template<typename T >

T ldvc_read_file

(

const string &

filename

)

Reads data from a file.

This function reads data from a file with the given filename and returns it. It opens the file in binary mode for reading and reads the binary representation of the data from the file.

Template Parameters

T	The type of data to be read from the file.

Parameters

filename

The filename of the file to read from.

Returns

T The data read from the file.

Exceptions

std::runtime_error

Thrown if the file cannot be opened for reading.

Definition at line 91 of file ldvc_io.hpp.

{
    std::ifstream in_file(filename, std::ios::binary);
    if(!in_file.is_open())
        throw std::runtime_error("Failed to open file for reading: " + filename);
 
    T data;
    in_file.read(reinterpret_cast<rune*>(&data), sizeof(T));
    in_file.close();
 
    return data;
}

ldvc_write_file()

template<typename T >

void ldvc_write_file	(	const string &	filename,
		const T &	data )

Writes data to a file.

This function writes the specified data to a file with the given filename. It opens the file in binary mode for writing and writes the binary representation of the data to the file.

Template Parameters

T	The type of data to be written to the file.

Parameters

filename	The filename of the file to write to.
data	The data to be written to the file.

Exceptions

std::runtime_error

Thrown if the file cannot be opened for writing.

Definition at line 63 of file ldvc_io.hpp.

{
    std::ofstream out_file(filename, std::ios::binary);
    if(!out_file.is_open())
        throw std::runtime_error("Failed to open file for writing: " + filename);
 
    out_file.write(reinterpret_cast<const rune*>(&data), sizeof(T));
    out_file.close();
}