Aphcity/suyu
1
0
Fork 0
forked from suyu/suyu
Code Pull requests Activity Actions

common: fs: Add a description of a regular file in IsFile

Browse source 
This provides a more concrete example of what a regular file is and isn't.
This commit is contained in:
Morph 2021-06-22 15:06:17 -04:00
parent 0394893354
commit 2fa207058b
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/common/fs/fs.h
View file

@ -48,7 +48,7 @@ template <typename Path>
* *
* Failures occur when: * Failures occur when:
* - Input path is not valid * - Input path is not valid
* - Filesystem object at path is not a file * - Filesystem object at path is not a regular file
* - Filesystem at path is read only * - Filesystem at path is read only
* *
* @param path Filesystem path * @param path Filesystem path
@ -74,7 +74,7 @@ bool RemoveFile(const Path& path) {
* Failures occur when: * Failures occur when:
* - One or both input path(s) is not valid * - One or both input path(s) is not valid
* - Filesystem object at old_path does not exist * - Filesystem object at old_path does not exist
* - Filesystem object at old_path is not a file * - Filesystem object at old_path is not a regular file
* - Filesystem object at new_path exists * - Filesystem object at new_path exists
* - Filesystem at either path is read only * - Filesystem at either path is read only
* *
@ -435,11 +435,13 @@ template <typename Path>
#endif #endif
/** /**
* Returns whether a filesystem object at path is a file. * Returns whether a filesystem object at path is a regular file.
* A regular file is a file that stores text or binary data.
* It is not a directory, symlink, FIFO, socket, block device, or character device.
* *
* @param path Filesystem path * @param path Filesystem path
* *
* @returns True if a filesystem object at path is a file, false otherwise. * @returns True if a filesystem object at path is a regular file, false otherwise.
*/ */
[[nodiscard]] bool IsFile(const std::filesystem::path& path); [[nodiscard]] bool IsFile(const std::filesystem::path& path);