XuMQ::FileHelper类 参考

文件操作帮助类 更多...

#include <helper.hpp>

Public 成员函数
	FileHelper (const std::string &filename)
	构造函数
bool	exists ()
	检查文件是否存在
size_t	size ()
	获取文件大小
bool	read (std::string &body)
	读取文件内容
bool	read (char *body, size_t offset, size_t len)
	从指定位置读取文件内容
bool	write (const std::string &body)
	写入字符串到文件
bool	write (const char *body, size_t offset, size_t len)
	从指定位置写入数据到文件
bool	rename (const std::string &nname)
	重命名文件

静态 Public 成员函数
static std::string	parentDirectory (const std::string &filename)
	获取文件的父目录
static bool	createFile (const std::string filename)
	创建新文件
static bool	removeFile (const std::string filename)
	删除文件
static bool	createDirectory (const std::string &pathname)
	创建目录
static bool	removeDirectory (const std::string &pathname)
	删除目录

Private 属性
std::string	_filename
	操作的文件名

详细描述

文件操作帮助类

该类提供了一系列静态和实例方法，用于处理文件和目录的操作，包括 检查文件是否存在、获取文件大小、读取和写入文件、重命名文件、创建 和删除文件及目录等功能

构造及析构函数说明

FileHelper()

XuMQ::FileHelper::FileHelper ( const std::string &  filename )

inline

构造函数

参数

filename

文件名

初始化 FileHelper 对象并设置要操作的文件名。

成员函数说明

createDirectory()

static bool XuMQ::FileHelper::createDirectory ( const std::string &  pathname )

inlinestatic

创建目录

参数

pathname

要创建的目录路径

返回

true 创建成功，false 创建失败

创建指定路径的目录及其所有父级目录。

函数调用图:

这是这个函数的调用关系图:

createFile()

static bool XuMQ::FileHelper::createFile ( const std::string  filename )

inlinestatic

创建新文件

参数

filename

新文件名

返回

true 创建成功，false 创建失败

在指定路径下创建一个新文件。

这是这个函数的调用关系图:

exists()

bool XuMQ::FileHelper::exists ( )

inline

检查文件是否存在

返回

true 如果文件存在，false 如果文件不存在

使用 stat 函数检查指定文件是否存在。

这是这个函数的调用关系图:

parentDirectory()

static std::string XuMQ::FileHelper::parentDirectory ( const std::string &  filename )

inlinestatic

获取文件的父目录

参数

filename

文件名

返回

文件的父目录路径，如果没有父目录则返回 "."

返回指定文件的父目录路径。

这是这个函数的调用关系图:

read() [1/2]

bool XuMQ::FileHelper::read ( char *  body, size_t  offset, size_t  len  )

inline

从指定位置读取文件内容

参数

body	存储读取内容的字符指针
offset	从文件的哪个位置开始读取
len	要读取的字节数

返回

true 读取成功，false 读取失败

从文件中读取指定数量的字节到提供的字符指针中。

read() [2/2]

bool XuMQ::FileHelper::read ( std::string &  body )

inline

读取文件内容

参数

body	存储读取内容的字符串引用

返回

true 读取成功，false 读取失败

读取整个文件的内容到给定的字符串中。

函数调用图:

这是这个函数的调用关系图:

removeDirectory()

static bool XuMQ::FileHelper::removeDirectory ( const std::string &  pathname )

inlinestatic

删除目录

参数

pathname

要删除的目录路径

返回

true 删除成功，false 删除失败

删除指定的目录及其所有内容。

这是这个函数的调用关系图:

removeFile()

static bool XuMQ::FileHelper::removeFile ( const std::string  filename )

inlinestatic

删除文件

参数

filename

要删除的文件名

返回

true 删除成功，false 删除失败

删除指定的文件。

这是这个函数的调用关系图:

rename()

bool XuMQ::FileHelper::rename ( const std::string &  nname )

inline

重命名文件

参数

nname

新文件名

返回

true 重命名成功，false 重命名失败

将指定的文件重命名为新的文件名。

函数调用图:

这是这个函数的调用关系图:

size()

size_t XuMQ::FileHelper::size ( )

inline

获取文件大小

返回

文件大小（字节数），如果文件不存在返回 0

使用 stat 函数获取指定文件的大小。

这是这个函数的调用关系图:

write() [1/2]

bool XuMQ::FileHelper::write ( const char *  body, size_t  offset, size_t  len  )

inline

从指定位置写入数据到文件

参数

body	要写入的字符指针
offset	文件中写入的起始位置
len	要写入的字节数

返回

true 写入成功，false 写入失败

将指定的字节写入到文件中的给定位置。

write() [2/2]

bool XuMQ::FileHelper::write ( const std::string &  body )

inline

写入字符串到文件

参数

body

要写入的字符串

返回

true 写入成功，false 写入失败

将整个字符串的内容写入到文件中。

函数调用图:

这是这个函数的调用关系图:

类成员变量说明

_filename

std::string XuMQ::FileHelper::_filename

private

操作的文件名