diff options
Diffstat (limited to 'src/common/fs/file.h')
| -rw-r--r-- | src/common/fs/file.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/src/common/fs/file.h b/src/common/fs/file.h index 0f10b6003..588fe619d 100644 --- a/src/common/fs/file.h +++ b/src/common/fs/file.h | |||
| @@ -49,7 +49,7 @@ void OpenFileStream(FileStream& file_stream, const Path& path, std::ios_base::op | |||
| 49 | 49 | ||
| 50 | /** | 50 | /** |
| 51 | * Reads an entire file at path and returns a string of the contents read from the file. | 51 | * Reads an entire file at path and returns a string of the contents read from the file. |
| 52 | * If the filesystem object at path is not a file, this function returns an empty string. | 52 | * If the filesystem object at path is not a regular file, this function returns an empty string. |
| 53 | * | 53 | * |
| 54 | * @param path Filesystem path | 54 | * @param path Filesystem path |
| 55 | * @param type File type | 55 | * @param type File type |
| @@ -72,7 +72,8 @@ template <typename Path> | |||
| 72 | /** | 72 | /** |
| 73 | * Writes a string to a file at path and returns the number of characters successfully written. | 73 | * Writes a string to a file at path and returns the number of characters successfully written. |
| 74 | * If a file already exists at path, its contents will be erased. | 74 | * If a file already exists at path, its contents will be erased. |
| 75 | * If the filesystem object at path is not a file, this function returns 0. | 75 | * If a file does not exist at path, it creates and opens a new empty file for writing. |
| 76 | * If the filesystem object at path exists and is not a regular file, this function returns 0. | ||
| 76 | * | 77 | * |
| 77 | * @param path Filesystem path | 78 | * @param path Filesystem path |
| 78 | * @param type File type | 79 | * @param type File type |
| @@ -95,7 +96,8 @@ template <typename Path> | |||
| 95 | 96 | ||
| 96 | /** | 97 | /** |
| 97 | * Appends a string to a file at path and returns the number of characters successfully written. | 98 | * Appends a string to a file at path and returns the number of characters successfully written. |
| 98 | * If the filesystem object at path is not a file, this function returns 0. | 99 | * If a file does not exist at path, it creates and opens a new empty file for appending. |
| 100 | * If the filesystem object at path exists and is not a regular file, this function returns 0. | ||
| 99 | * | 101 | * |
| 100 | * @param path Filesystem path | 102 | * @param path Filesystem path |
| 101 | * @param type File type | 103 | * @param type File type |
| @@ -394,11 +396,11 @@ public: | |||
| 394 | [[nodiscard]] size_t WriteString(std::span<const char> string) const; | 396 | [[nodiscard]] size_t WriteString(std::span<const char> string) const; |
| 395 | 397 | ||
| 396 | /** | 398 | /** |
| 397 | * Flushes any unwritten buffered data into the file. | 399 | * Attempts to flush any unwritten buffered data into the file and flush the file into the disk. |
| 398 | * | 400 | * |
| 399 | * @returns True if the flush was successful, false otherwise. | 401 | * @returns True if the flush was successful, false otherwise. |
| 400 | */ | 402 | */ |
| 401 | [[nodiscard]] bool Flush() const; | 403 | bool Flush() const; |
| 402 | 404 | ||
| 403 | /** | 405 | /** |
| 404 | * Resizes the file to a given size. | 406 | * Resizes the file to a given size. |