Files
XCEngine/docs/api/core/filewriter/filewriter.md

69 lines
1.9 KiB
Markdown
Raw Normal View History

# FileWriter
**命名空间**: `XCEngine::Core`
**类型**: `class`
2026-03-20 02:35:07 +08:00
**头文件**: `XCEngine/Core/FileWriter.h`
**描述**: 文件写入工具类,提供简单的文件写入操作封装。
## 概述
`FileWriter` 是一个轻量级的文件写入工具,封装了 `FILE*` 接口提供便捷的字符串和二进制数据写入功能。它支持追加模式和自动资源管理RAII
## 公共方法
| 方法 | 描述 |
|------|------|
| [`FileWriter()`](constructor.md) | 默认构造(不打开文件) |
| [`FileWriter(filePath, append)`](constructor.md) | 构造并打开文件 |
| [`~FileWriter()`](destructor.md) | 析构函数,自动关闭文件 |
| [`Open`](Open.md) | 打开文件append=true 时为追加模式 |
| [`Close`](Close.md) | 关闭文件 |
| [`IsOpen`](IsOpen.md) | 检查文件是否已打开 |
| [`Write`](Write.md) | 写入数据 |
| [`Flush`](Flush.md) | 刷新缓冲区 |
## 使用示例
```cpp
#include <XCEngine/Core/FileWriter.h>
#include <XCEngine/Core/Containers/String.h>
using namespace XCEngine::Core;
// 方式1构造时打开
FileWriter writer("output.txt", false);
if (writer.IsOpen()) {
writer.Write("Hello, World!\n");
writer.Write("Line 2\n");
writer.Flush();
}
// 方式2先构造再打开
FileWriter writer2;
if (writer2.Open("log.txt")) {
writer2.Write("Application started\n");
writer2.Close();
}
// 追加模式
FileWriter appendWriter("log.txt", true);
if (appendWriter.IsOpen()) {
appendWriter.Write("Another log entry\n");
appendWriter.Flush();
}
// 使用 String 写入
Containers::String content = "Content written from String";
FileWriter writer3("data.txt");
writer3.Write(content);
```
## 相关文档
- [Core 模块总览](../core.md) - 返回模块总览
- [Logger](../../debug/logger/logger.md) - 日志系统
- [FileLogSink](../../debug/filelogsink/filelogsink.md) - 文件日志输出