package b0

You can search for identifiers within the package.

in-package search v0.2.0

Software construction and deployment kit

Install

Dune Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (6)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.1.tbz

sha256=dba2fc571f39f3b8e87ee55c77bdec7ec6a5ddc7d99b8b20aeda848af546be04

md5=51ee1d66acc4d7f87bdceac1341b7711

doc/b0.b00/B000/Trash/index.html

Module `B000.Trash`

Delete file hierarchies.

Deleting file hierarchies may be slow. This clears a given path by moving it to a trash directory which can be deleted at the end of the build asynchronously.

type t

The type for trashes.

val create : B00_std.Fpath.t -> t

create dir is a trash using directory dir for data storage. dir may not exist.

val dir : t -> B00_std.Fpath.t

dir t is the trash's directory (may not exist)

val trash : t -> B00_std.Fpath.t -> (unit, string) result

trash t p trashes path p in dir t. If p does not exist this has no effect. Note that p needs to be on the same device as dir t and that the latter is created if needed.

val delete : block:bool -> t -> (unit, string) result

delete ~block t deletes t's trash directory and its content. If block is true the operation is synchronous and blocks until the trash is effectively deleted; if false the operation is spawn as a separate process.

Note. On Windows block:false relies on cmd.exe being available.