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
|
(* arch-tag: unix utilities interface file
Copyright (c) 2004 John Goerzen *)
(** Unix utilities.
This module provides various helpful utilities for use with the built-in
Unix module.
@author Copyright (C) 2004 John Goerzen <jgoerzen\@complete.org>
*)
(** {6 File functions}
These functions help process files
*)
(** Returns true if the specified file exists; false otherwise. *)
val exists: string -> bool
(** Returns true if the specified file exists and is a directory. *)
val isdir: string -> bool
(** {6 Directory processing}
These functions help process directories.
*)
(** Returns a list of all entries, exclusive of "." and "..", in the
specified directory. *)
val list_of_dir: string -> string list
(** Folds over the specified directory *)
val fold_directory: ('a -> string -> 'a) -> 'a -> string -> 'a
(** {[recurse_stream name]} will create a stream that yields a (stats, name)
pair for every entry beneath the given filename (including the
filename itself. It's a depth-first traversal.
The stats are included because a lot of people want to check on
the type of file for each file in the list. You can see if you have
a directory by:
{[
match stats.st_kind with
S_DIR -> ...
| _ -> ...
]}
*)
val recurse_stream: string -> (string * Unix.stats) Stream.t
(** Same as {!Unixutil.recurse_stream}, but generates a list instead.
Not recommended since this list could be *huge*. *)
val recurse_list: string -> (string * Unix.stats) list
(** {[recurse_cmd func name]} will call {[func stats name]} on every entry
in or beneath name, which may specify a directory or a file. For entries
in subdirectires, the full relative path starting from name will be
passed. *)
val recurse_cmd: (string * Unix.stats -> unit) -> string -> unit
(** Returns the absolute path of name.
This does not necessarily resolve symlinks.
Side-effects: the current working directory is briefly changed, but is changed
back. If [os.getcwd ()] returns an invalid cwd to start with, results
are undefined and may cause an exception (since it then cannot change back).
This circumstance is rare and probably not of concern to you.
*)
val abspath: string -> string
(** {6 Shell replacements}
These functions replace standard shell functions with the same name.
*)
(** Remove files or directories.
By default, will remove only a given file and will raise an
error if it fails to do so.
if ~force is given and is set true, errors are never raised but simply ignored.
If ~recursive is given and is set true, a directory
name may be given. The directory and all entries beneath it will
be removed.
*)
val rm: ?recursive:bool -> ?force:bool -> string -> unit
|
