File::tryOpen

Summary:
Now that we have truthy files, it would be nice to be able to simply
//try// opening files and return a possibly-initialized File.

Test Plan: Unit tests

Reviewed By: chaoyc@fb.com

FB internal diff: D726916

diff --git a/folly/File.cpp b/folly/File.cpp
index 1262dd1c3aaedab8616e2d45d19a9c1267147c02..4998ec1fa1113067d94f3566121b2ec32d1c8ce7 100644 (file)
--- a/folly/File.cpp
+++ b/folly/File.cpp
@@ -79,6 +79,16 @@ File::~File() {
   return File(fd, true);
 }
 
+/* static */ File File::tryOpen(const char* name,
+                                int flags,
+                                mode_t mode) {
+  try {
+    return File(name, flags, mode);
+  } catch (const std::system_error&) {
+    return File();
+  }
+}
+
 void File::release() {
   fd_ = -1;
   ownsFd_ = false;

diff --git a/folly/File.h b/folly/File.h
index e990c91bfc14efcd0274dc01c6c84edf63237315..edcad92025bcf996ffd4ed66dd77766c9f414520 100644 (file)
--- a/folly/File.h
+++ b/folly/File.h
@@ -54,6 +54,14 @@ class File {
    */
   static File temporary();
 
+  /**
+   * Attempts to open the file at the given path.  Returns an 'closed` File
+   * instance on failure, which will evaluate to false.
+   */
+  static File tryOpen(const char* name,
+                      int flags = O_RDONLY,
+                      mode_t mode = 0644);
+
   /**
    * Return the file descriptor, or -1 if the file was closed.
    */

diff --git a/folly/test/FileTest.cpp b/folly/test/FileTest.cpp
index 4f47f0fec2b2e6328e9d29941acdb657165b8258..96ebb7e5636f0f6ca44c23d6f96315663c23196a 100644 (file)
--- a/folly/test/FileTest.cpp
+++ b/folly/test/FileTest.cpp
@@ -122,3 +122,8 @@ TEST(File, Truthy) {
     EXPECT_TRUE(false);
   }
 }
+
+TEST(File, TryOpen) {
+  EXPECT_FALSE(!!File::tryOpen("does_not_exist.txt"));
+  EXPECT_TRUE(!!File::tryOpen("/etc/fstab"));
+}