Merge pull request #627 from talex5/rmtree

Add Path.rmtree

Author: talex5

lib_eio/path.ml

@@ -72,7 +72,9 @@ let open_out ~sw ?(append=false) ~create t =
 let open_dir ~sw t =
   let (Resource.T (dir, ops), path) = t in
   let module X = (val (Resource.get ops Fs.Pi.Dir)) in
-  try X.open_dir dir ~sw path, ""
+  try
+    let sub = X.open_dir dir ~sw path, "" in
+    (sub : [`Close | `Dir] t :> [< `Close | `Dir] t)
   with Exn.Io _ as ex ->
     let bt = Printexc.get_raw_backtrace () in
     Exn.reraise_with_context ex bt "opening directory %a" pp t
@@ -163,6 +165,19 @@ let rmdir t =
     let bt = Printexc.get_raw_backtrace () in
     Exn.reraise_with_context ex bt "removing directory %a" pp t
 
+let rec rmtree (t : Fs.dir_ty t) =
+  with_open_dir t (fun t ->
+      read_dir t |> List.iter (fun name ->
+          let item = t / name in
+          match kind ~follow:false item with
+          | `Directory -> rmtree item
+          | _ -> unlink item
+        )
+    );
+  rmdir t
+
+let rmtree = (rmtree : Fs.dir_ty t -> unit :> [> Fs.dir_ty] t -> unit)
+
 let rename t1 t2 =
   let (dir2, new_path) = t2 in
   let (Resource.T (dir, ops), old_path) = t1 in

lib_eio/path.mli

@@ -139,12 +139,12 @@ val mkdirs : ?exists_ok:bool -> perm:File.Unix_perm.t -> _ t -> unit
 
     @param exist_ok If [false] (the default) then we raise {! Fs.Already_exists} if [t] is already a directory. *)
 
-val open_dir : sw:Switch.t -> _ t -> [`Close | dir_ty] t
+val open_dir : sw:Switch.t -> _ t -> [< `Close | dir_ty] t
 (** [open_dir ~sw t] opens [t].
 
     This can be passed to functions to grant access only to the subtree [t]. *)
 
-val with_open_dir : _ t -> ([`Close | dir_ty] t -> 'a) -> 'a
+val with_open_dir : _ t -> ([< `Close | dir_ty] t -> 'a) -> 'a
 (** [with_open_dir] is like [open_dir], but calls [fn dir] with the new directory and closes
     it automatically when [fn] returns (if it hasn't already been closed by then). *)
 
@@ -192,6 +192,9 @@ val rmdir : _ t -> unit
 
     Note: this usually requires the directory to be empty. *)
 
+val rmtree : _ t -> unit
+(** [rmtree t] removes directory [t] and its contents, recursively. *)
+
 val rename : _ t -> _ t -> unit
 (** [rename old_t new_t] atomically unlinks [old_t] and links it as [new_t].
 

tests/fs.md

@@ -61,6 +61,11 @@ let try_rmdir path =
   | () -> traceln "rmdir %a -> ok" Path.pp path
   | exception ex -> traceln "@[<h>%a@]" Eio.Exn.pp ex
 
+let try_rmtree path =
+  match Path.rmtree path with
+  | () -> traceln "rmtree %a -> ok" Path.pp path
+  | exception ex -> traceln "@[<h>%a@]" Eio.Exn.pp ex
+
 let chdir path =
   traceln "chdir %S" path;
   Unix.chdir path
@@ -397,6 +402,23 @@ Removing something that doesn't exist or is out of scope:
 - : unit = ()
 ```
 
+# Recursive removal
+
+```ocaml
+# run @@ fun env ->
+  Switch.run @@ fun sw ->
+  let cwd = Eio.Stdenv.cwd env in
+  let foo = cwd / "foo" in
+  try_mkdirs (foo / "bar"/ "baz");
+  try_write_file ~create:(`Exclusive 0o600) (foo / "bar/file1") "data";
+  try_rmtree foo;
+  assert (Path.kind ~follow:false foo = `Not_found);
++mkdirs <cwd:foo/bar/baz> -> ok
++write <cwd:foo/bar/file1> -> ok
++rmtree <cwd:foo> -> ok
+- : unit = ()
+```
+
 # Limiting to a subdirectory
 
 Create a sandbox, write a file with it, then read it from outside: