1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
(** The module [Filesystem] contain helpers to browse and operate on
files and directories of a file system. It uses the abstraction
provided by the module [Filepath].
*)
(** Exceptions *)
(** Raised by [removeDirContent] whenever trying to delete a block or
char device. *)
exception UnexpectedFileType of string
(** Raised by [write_no_partial]. *)
exception WriteFailed
(** Removes the contents of a directory. Raises [UnexpectedFileType]
if the directory contain a file representing a block or a
character device. *)
val removeDirContent : Filepath.filepath -> unit
(** Remove a directory and its content. *)
val removeDir : Filepath.filepath -> unit
(** [iterate f fp] calls [f] on each filename contained in [fp]
(excluding "." and ".."). Note that a filename can represent
either a file or a directory in the file system. *)
val iterate : (Filepath.filename -> unit) -> Filepath.filepath -> unit
(** [list_dir_pred_map f fp] applies [f] to each filename contained in
[fp] using [iterate], and returns all elements that have been
obtained when [f] did not return [None]. *)
val list_dir_pred_map :
(Filepath.filename -> 'a option) -> Filepath.filepath -> 'a list
(** [list_dir_pred pred fp] returns a list of filenames (obtained with
[iterate] that satisfy the predicate [pred]. *)
val list_dir_pred :
(Filepath.filename -> bool) -> Filepath.filepath -> Filepath.filename list
(** [list_dir fp] returns the files (and directories) under [fp]
(excluding "." and ".."). *)
val list_dir : Filepath.filepath -> Filepath.filename list
(** [list_dir_path_pred pred fp] returns the paths contained in [fp],
including ".", that satisfy [pred]. *)
val list_dir_path_pred :
(string -> bool) -> Filepath.filepath -> Filepath.filepath list
(** [list_dir_path fp] returns the paths contained in [fp], including
".".*)
val list_dir_path : Filepath.filepath -> Filepath.filepath list
(** Returns the modification time of a filepath, or returns [0.] if
any error occured. *)
val getModificationTime : Filepath.filepath -> float
(** Analogous of [Sys.file_exists] but for a filepath *)
val exists : Filepath.filepath -> bool
(** Analogous of [Sys.is_directory] but for a filepath *)
val is_dir : Filepath.filepath -> bool
(** [mkdirSafe fp perms] creates a directory at [fp] unless a
directory or a file already exists here. Return [false] if a
directory already exists, [true] if the directory has just been
created, and raise an exception [Failure] if a file already exists
at this location. *)
val mkdirSafe : Filepath.filepath -> Unix.file_perm -> bool
(** Analogous to [ignore (mkdirSafe fp perms). *)
val mkdirSafe_ : Filepath.filepath -> Unix.file_perm -> unit
(** Recursively create directories with [mkdirSafe_] until the all
directories on the filepath specified as argument exists. *)
val mkdirSafeRecursive : Filepath.filepath -> Unix.file_perm -> unit
(** [create_or_empty_dir fp] will create a directory at [fp]. If a
directory already exists at [fp], remote its content. *)
val create_or_empty_dir : Filepath.filepath -> unit
(** [write_no_partial fd buf start len] writes [len] chars of [buf]
starting at [start] in [fd], or raises [WriteFailed] if
impossible. *)
val write_no_partial : Unix.file_descr -> string -> int -> int -> unit
(** [withfile fp flags perms f] opens the file at [fp] and apply [f]
to the obtained file descriptor. *)
val withfile :
Filepath.filepath ->
Unix.open_flag list -> Unix.file_perm -> (Unix.file_descr -> 'a) -> 'a
(** Functions for writing/reading to/from a file in a filesystem. *)
val writeFile : Filepath.filepath -> string -> unit
val readFile : Filepath.filepath -> string
(** Functions for copying files. *)
(** [copy_file src dst] will copy file [src] to [dst]. *)
val copy_file : Filepath.filepath -> Filepath.filepath -> unit
(** [copy_to_dir src dst] fill copy file [src] in directory [dst]. *)
val copy_to_dir : Filepath.filepath -> Filepath.filepath -> unit
(** [copy_many_files srcs dst] will copy files [srcs] in the directory
[dst]. *)
val copy_many_files : Filepath.filepath list -> Filepath.filepath -> unit
(** [mktemp_dir_in prefix] creates a temporary directory in the
current working directory, whose name starts with [prefix] but is
otherwise random. *)
val mktemp_dir_in : string -> Filepath.filepath
|
