Merge pull request #623 from talex5/kind

Add Eio.Path.{kind, is_file, is_directory}

Author: talex5

lib_eio/path.ml

@@ -69,6 +69,16 @@ let stat ~follow t =
     let bt = Printexc.get_raw_backtrace () in
     Exn.reraise_with_context ex bt "examining %a" pp t
 
+let kind ~follow t =
+  try ((stat ~follow t).kind :> [File.Stat.kind | `Not_found])
+  with Exn.Io (Fs.E Not_found _, _) -> `Not_found
+
+let is_file t =
+  kind ~follow:true t = `Regular_file
+
+let is_directory t = 
+  kind ~follow:true t = `Directory
+
 let with_open_in path fn =
   Switch.run @@ fun sw -> fn (open_in ~sw path)
 

lib_eio/path.mli

@@ -128,14 +128,29 @@ val read_dir : _ t -> string list
 
     Note: The special Unix entries "." and ".." are not included in the results. *)
 
-(** {2 Metadata} *)
+(** {1 Metadata} *)
 
 val stat : follow:bool -> _ t -> File.Stat.t
 (** [stat ~follow t] returns metadata about the file [t].
 
     If [t] is a symlink, the information returned is about the target if [follow = true],
     otherwise it is about the link itself. *)
 
+val kind : follow:bool -> _ t -> [ File.Stat.kind | `Not_found ]
+(** [kind ~follow t] is the type of [t], or [`Not_found] if it doesn't exist.
+
+    @param follow If [true] and [t] is a symlink, return the type of the target rather than [`Symbolic_link]. *)
+
+val is_file : _ t -> bool
+(** [is_file t] is [true] if [t] is a regular file, and [false] if it doesn't exist or has a different type.
+
+    [is_file t] is [kind ~follow:true t = `Regular_file]. *)
+
+val is_directory : _ t -> bool
+(** [is_directory t] is [true] if [t] is a directory, and [false] if it doesn't exist or has a different type.
+
+    [is_directory t] is [kind ~follow:true t = `Directory]. *)
+
 (** {1 Other} *)
 
 val unlink : _ t -> unit

tests/fs.md

@@ -59,10 +59,6 @@ let try_rmdir path =
 let chdir path =
   traceln "chdir %S" path;
   Unix.chdir path
-
-let assert_kind path kind =
-  Path.with_open_in path @@ fun file ->
-  assert ((Eio.File.stat file).kind = kind)
 ```
 
 # Basic test cases
@@ -224,7 +220,9 @@ You can remove a file using unlink:
   Path.save ~create:(`Exclusive 0o600) (cwd / "subdir/file2") "data2";
   try_read_file (cwd / "file");
   try_read_file (cwd / "subdir/file2");
+  assert (Eio.Path.kind ~follow:true (cwd / "file") = `Regular_file);
   try_unlink (cwd / "file");
+  assert (Eio.Path.kind ~follow:true (cwd / "file") = `Not_found);
   try_unlink (cwd / "subdir/file2");
   try_read_file (cwd / "file");
   try_read_file (cwd / "subdir/file2");
@@ -541,9 +539,9 @@ let try_stat path =
   let cwd = Eio.Stdenv.cwd env in
   Switch.run @@ fun sw ->
   try_mkdir (cwd / "stat_subdir");
-  assert_kind (cwd / "stat_subdir") `Directory;
+  assert (Eio.Path.is_directory (cwd / "stat_subdir"));
   try_write_file (cwd / "stat_reg") "kingbula" ~create:(`Exclusive 0o600);
-  assert_kind (cwd / "stat_reg") `Regular_file;;
+  assert (Eio.Path.is_file (cwd / "stat_reg"));
 +mkdir <cwd:stat_subdir> -> ok
 +write <cwd:stat_reg> -> ok
 - : unit = ()
@@ -565,13 +563,15 @@ Fstatat:
   try_stat (cwd / "..");
   Unix.symlink ".." "parent-symlink";
   try_stat (cwd / "parent-symlink");
+  try_stat (cwd / "missing1" / "missing2");
 +mkdir <cwd:stat_subdir2> -> ok
 +<cwd:stat_subdir2> -> directory
 +<cwd:symlink> -> symbolic link / directory
 +<cwd:broken-symlink> -> symbolic link / Fs Not_found _
 +<cwd> -> directory
 +<cwd:..> -> Fs Permission_denied _
 +<cwd:parent-symlink> -> symbolic link / Fs Permission_denied _
++<cwd:missing1/missing2> -> Fs Not_found _
 - : unit = ()
 ```