summaryrefslogtreecommitdiffstats
path: root/src/common/fs/file.h
diff options
context:
space:
mode:
authorMorph <39850852+Morph1984@users.noreply.github.com>2021-06-19 09:49:11 +0200
committerMorph <39850852+Morph1984@users.noreply.github.com>2021-06-22 21:06:58 +0200
commit76b2313b25e2fd33a508f63137d5113e1ca85150 (patch)
treeda79f542733f16ca27b834da5805a75503b1019a /src/common/fs/file.h
parentcommon: fs: file: Remove [[nodiscard]] attribute from Flush (diff)
downloadyuzu-76b2313b25e2fd33a508f63137d5113e1ca85150.tar
yuzu-76b2313b25e2fd33a508f63137d5113e1ca85150.tar.gz
yuzu-76b2313b25e2fd33a508f63137d5113e1ca85150.tar.bz2
yuzu-76b2313b25e2fd33a508f63137d5113e1ca85150.tar.lz
yuzu-76b2313b25e2fd33a508f63137d5113e1ca85150.tar.xz
yuzu-76b2313b25e2fd33a508f63137d5113e1ca85150.tar.zst
yuzu-76b2313b25e2fd33a508f63137d5113e1ca85150.zip
Diffstat (limited to 'src/common/fs/file.h')
-rw-r--r--src/common/fs/file.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/common/fs/file.h b/src/common/fs/file.h
index 087b2993a..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
/**
* Reads an entire file at path and returns a string of the contents read from the file.
- * If the filesystem object at path is not a file, this function returns an empty string.
+ * If the filesystem object at path is not a regular file, this function returns an empty string.
*
* @param path Filesystem path
* @param type File type
@@ -72,7 +72,8 @@ template <typename Path>
/**
* Writes a string to a file at path and returns the number of characters successfully written.
* If a file already exists at path, its contents will be erased.
- * If the filesystem object at path is not a file, this function returns 0.
+ * If a file does not exist at path, it creates and opens a new empty file for writing.
+ * If the filesystem object at path exists and is not a regular file, this function returns 0.
*
* @param path Filesystem path
* @param type File type
@@ -95,7 +96,8 @@ template <typename Path>
/**
* Appends a string to a file at path and returns the number of characters successfully written.
- * If the filesystem object at path is not a file, this function returns 0.
+ * If a file does not exist at path, it creates and opens a new empty file for appending.
+ * If the filesystem object at path exists and is not a regular file, this function returns 0.
*
* @param path Filesystem path
* @param type File type