Document maybeLstat

Co-authored-by: Théophane Hufschmitt <[email protected]>
NixOS · Mar 30, 2024 · 3752bbe · 3752bbe
1 parent 8be347a
commit 3752bbe
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/libutil/file-system.hh b/src/libutil/file-system.hh
@@ -84,6 +84,10 @@ bool isDirOrInDir(std::string_view path, std::string_view dir);
  */
 struct stat stat(const Path & path);
 struct stat lstat(const Path & path);
+/**
+ * `lstat` the given path if it exists.
+ * @return std::nullopt if the path doesn't exist, or an optional containing the result of `lstat` otherwise
+ */
 std::optional<struct stat> maybeLstat(const Path & path);
 
 /**