TpFile 类
V0.2.1TpUtils
2025-11-14
介绍
文件操作类，提供文件处理和I/O功能
基础信息
| 头文件: | include <TpFile.h> |
|---|---|
| Cmake: | None |
| 发布版本: | V0.2.1 |
| 继承类: | |
| 派生类: |
Public 类型
enum TpFile::OpenModeFlag
| 名称 | 值 | 描述 |
|---|---|---|
| NotOpen | 0x0000 | 文件未打开 |
| ReadOnly | 0x0001 | 以只读模式打开文件 |
| WriteOnly | 0x0002 | 以只写模式打开文件 |
| ReadWrite | ReadOnly | WriteOnly | 以读写模式打开文件 |
| Append | 0x0004 | 以追加模式打开文件（写入位置在文件末尾） |
| ReadWriteAppend | 0x0008 |
Public 成员函数
| TpFile() | 默认构造函数 - 创建未初始化的文件对象 | |
|---|---|---|
| TpFile(const TpString &_fileName) | 构造函数 - 使用指定文件名初始化 | |
| ~TpFile() | 析构函数 - 自动关闭已打开的文件 | |
| TpString | fileName() const | 获取当前关联的文件名 |
| setFileName(const TpString &name) | 设置新的文件名 | |
| TpFileInfo | fileInfo() | 获取文件的详细信息 |
| exists() const | 检查当前关联的文件是否存在 | |
| remove() | 删除当前关联的文件 | |
| rename(const TpString &newName) | 重命名当前关联的文件 | |
| copy(const TpString &newName) | 创建当前文件的副本 | |
| size() const | 获取文件大小 | |
| open(OpenModeFlag mode) | 以指定模式打开文件 | |
| isOpen() const | 检查文件是否已打开 | |
| isReadable() const | 检查文件是否可读（以读模式打开） | |
| isWritable() const | 检查文件是否可写（以写模式打开） | |
| close() | 关闭当前打开的文件 | |
| pos() const | 获取当前读写位置 | |
| seek(uint64_t offset) | 设置文件读写位置 | |
| atEnd() const | 检查是否到达文件末尾 | |
| flush() | 刷新写缓冲区到磁盘 | |
| read(char *data, uint64_t maxlen) | 从文件读取数据到缓冲区 | |
| TpString | read(uint64_t maxlen) | 读取最多指定字节数作为字符串 |
| TpString | readAll() | 读取文件全部内容 |
| readLine(char *data, uint64_t maxlen) | 读取一行数据到缓冲区 | |
| TpString | readLine(uint64_t maxlen=0) | 读取一行数据作为字符串 |
| write(const char *data, uint64_t len) | 写入二进制数据到文件 | |
| write(const char *data) | 写入C字符串到文件 | |
| write(const TpString &data) | 写入tpString数据到文件 | |
| exists(const TpString &fileName) | 检查文件系统中是否存在指定文件 | |
| remove(const TpString &fileName) | 删除指定文件 | |
| rename(const TpString &oldName, const TpString &newName) | 重命名/移动文件到新位置 | |
| copy(const TpString &fileName, const TpString &newName) | 复制文件到新位置 |
成员函数说明
TpFile::TpFile()
默认构造函数 - 创建未初始化的文件对象...
默认构造函数 - 创建未初始化的文件对象
TpFile::TpFile(const TpString &_fileName)
构造函数 - 使用指定文件名初始化...
构造函数 - 使用指定文件名初始化
参数：_fileName: 目标文件的完整路径
TpFile::~TpFile()
析构函数 - 自动关闭已打开的文件...
析构函数 - 自动关闭已打开的文件
TpString TpFile::fileName() const
获取当前关联的文件名...
获取当前关联的文件名
返回值：当前文件名的tpString对象
void TpFile::setFileName(const TpString &name)
设置新的文件名...
设置新的文件名
参数：name: 新关联的文件路径
TpFileInfo TpFile::fileInfo()
获取文件的详细信息...
获取文件的详细信息
返回值：包含文件元数据的tpFileInfo对象
bool TpFile::exists() const
检查当前关联的文件是否存在...
检查当前关联的文件是否存在
返回值：存在返回true，否则返回false
bool TpFile::remove()
删除当前关联的文件...
删除当前关联的文件
返回值：成功删除返回true，否则返回false
bool TpFile::rename(const TpString &newName)
重命名当前关联的文件...
重命名当前关联的文件
参数：newName: 新的文件完整路径
返回值：重命名成功返回true，否则返回false
bool TpFile::copy(const TpString &newName)
创建当前文件的副本...
创建当前文件的副本
参数：newName: 副本文件的完整路径
返回值：复制成功返回true，否则返回false
uint64_t TpFile::size() const
获取文件大小...
获取文件大小
返回值：文件大小（字节数），不可用则返回0
bool TpFile::open(OpenModeFlag mode)
以指定模式打开文件...
以指定模式打开文件
参数：mode: 打开模式标志组合
返回值：成功打开返回true，否则返回false
bool TpFile::isOpen() const
检查文件是否已打开...
检查文件是否已打开
返回值：已打开返回true，否则返回false
bool TpFile::isReadable() const
检查文件是否可读（以读模式打开）...
检查文件是否可读（以读模式打开）
返回值：可读返回true，否则返回false
bool TpFile::isWritable() const
检查文件是否可写（以写模式打开）...
检查文件是否可写（以写模式打开）
返回值：可写返回true，否则返回false
void TpFile::close()
关闭当前打开的文件...
关闭当前打开的文件
uint64_t TpFile::pos() const
获取当前读写位置...
获取当前读写位置
返回值：当前文件位置（字节偏移量）
bool TpFile::seek(uint64_t offset)
设置文件读写位置...
设置文件读写位置
参数：offset: 目标位置字节偏移量
返回值：定位成功返回true，否则返回false
bool TpFile::atEnd() const
检查是否到达文件末尾...
检查是否到达文件末尾
返回值：到达文件尾返回true，否则返回false
bool TpFile::flush()
刷新写缓冲区到磁盘...
刷新写缓冲区到磁盘
返回值：刷新成功返回true，否则返回false
uint64_t TpFile::read(char *data, uint64_t maxlen)
从文件读取数据到缓冲区...
从文件读取数据到缓冲区
参数：data: 接收数据的缓冲区
参数：maxlen: 最多读取的字节数
返回值：实际读取的字节数
TpString TpFile::read(uint64_t maxlen)
读取最多指定字节数作为字符串...
读取最多指定字节数作为字符串
参数：maxlen: 最多读取的字节数
返回值：包含读取数据的tpString对象
TpString TpFile::readAll()
读取文件全部内容...
读取文件全部内容
返回值：包含文件完整内容的tpString对象
uint64_t TpFile::readLine(char *data, uint64_t maxlen)
读取一行数据到缓冲区...
读取一行数据到缓冲区
参数：data: 接收行数据的缓冲区
参数：maxlen: 最多读取的字节数
返回值：实际读取的字节数（包含行终止符）
TpString TpFile::readLine(uint64_t maxlen=0)
读取一行数据作为字符串...
读取一行数据作为字符串
参数：maxlen: 最多读取的字节数（0表示无限制）
返回值：包含行数据的tpString对象
uint64_t TpFile::write(const char *data, uint64_t len)
写入二进制数据到文件...
写入二进制数据到文件
参数：data: 要写入的数据缓冲区
参数：len: 要写入的字节数
返回值：实际写入的字节数
uint64_t TpFile::write(const char *data)
写入C字符串到文件...
写入C字符串到文件
参数：data: 要写入的C字符串（空值结尾）
返回值：实际写入的字节数（不包含终止符）
uint64_t TpFile::write(const TpString &data)
写入tpString数据到文件...
写入tpString数据到文件
参数：data: 要写入的字符串数据
返回值：实际写入的字节数
static bool TpFile::exists(const TpString &fileName)
检查文件系统中是否存在指定文件...
检查文件系统中是否存在指定文件
参数：fileName: 要检查的文件完整路径
返回值：存在返回true，否则返回false
static bool TpFile::remove(const TpString &fileName)
删除指定文件...
删除指定文件
参数：fileName: 要删除的文件完整路径
返回值：成功删除返回true，否则返回false
static bool TpFile::rename(const TpString &oldName, const TpString &newName)
重命名/移动文件到新位置...
重命名/移动文件到新位置
参数：oldName: 文件当前完整路径
参数：newName: 文件新完整路径
返回值：重命名成功返回true，否则返回false
static bool TpFile::copy(const TpString &fileName, const TpString &newName)
复制文件到新位置...
复制文件到新位置
参数：fileName: 要复制的源文件路径
参数：newName: 目标文件路径
返回值：复制成功返回true，否则返回false
