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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
(** This module provides an effects-based API for calling POSIX functions.
Normally it's better to use the cross-platform {!Eio} APIs instead,
which uses these functions automatically where appropriate.
These functions mostly copy the POSIX APIs directly, except that:
+ They suspend the calling fiber instead of returning [EAGAIN] or similar.
+ They handle [EINTR] by automatically restarting the call.
+ They wrap {!Unix.file_descr} in {!Fd}, to avoid use-after-close bugs.
+ They attach new FDs to switches, to avoid resource leaks. *)
open Eio.Std
type fd := Eio_unix.Fd.t
val await_readable : fd -> unit
val await_writable : fd -> unit
val sleep_until : Mtime.t -> unit
val read : fd -> bytes -> int -> int -> int
val read_cstruct : fd -> Cstruct.t -> int
val write : fd -> bytes -> int -> int -> int
val write_cstruct : fd -> Cstruct.t -> int
val socket : sw:Switch.t -> Unix.socket_domain -> Unix.socket_type -> int -> fd
val connect : fd -> Unix.sockaddr -> unit
val accept : sw:Switch.t -> fd -> fd * Unix.sockaddr
val shutdown : fd -> Unix.shutdown_command -> unit
val recv_msg : fd -> bytes -> int * Unix.sockaddr
val send_msg : fd -> ?dst:Unix.sockaddr -> bytes -> int
val getrandom : Cstruct.t -> unit
val lseek : fd -> Optint.Int63.t -> [`Set | `Cur | `End] -> Optint.Int63.t
val fsync : fd -> unit
val ftruncate : fd -> Optint.Int63.t -> unit
val fstat : fd -> Unix.LargeFile.stats
val lstat : string -> Unix.LargeFile.stats
val realpath : string -> string
val read_link : ?dirfd:fd -> string -> string
val mkdir : ?dirfd:fd -> ?nofollow:bool -> mode:int -> string -> unit
val unlink : ?dirfd:fd -> dir:bool -> string -> unit
val rename : ?old_dir:fd -> string -> ?new_dir:fd -> string -> unit
val symlink : link_to:string -> fd option -> string -> unit
(** [symlink ~link_to dir path] will create a new symlink at [dir / path]
linking to [link_to]. *)
val readdir : string -> string array
val readv : fd -> Cstruct.t array -> int
val writev : fd -> Cstruct.t list -> unit
val preadv : file_offset:Optint.Int63.t -> fd -> Cstruct.t array -> int
val pwritev : file_offset:Optint.Int63.t -> fd -> Cstruct.t array -> int
val pipe : sw:Switch.t -> fd * fd
module Flags : sig
module Open : sig
type t
val rdonly : t
val rdwr : t
val wronly : t
val creat : t
val excl : t
val trunc : t
val generic_read : t
val generic_write : t
val synchronise : t
val append : t
val empty : t
val ( + ) : t -> t -> t
end
module Disposition : sig
type t
val supersede : t
(** If the file already exists, replace it with the given file.
If it does not, create the given file. *)
val create : t
(** Create the file, if it already exists fail. *)
val open_ : t
(** If the file already exists, open it otherwise fail. *)
val open_if : t
(** If the file already exists, open it otherwise create it. *)
val overwrite : t
(** If the file already exists, open it and overwrite it otherwise fail. *)
val overwrite_if : t
(** If the file already exists, open it and overwrite it otherwise create it. *)
end
module Create : sig
type t
val directory : t
(** Create a directory. *)
val non_directory : t
(** Create something that is not a directory. *)
val no_intermediate_buffering : t
val write_through : t
val sequential_only : t
val ( + ) : t -> t -> t
end
end
val openat : ?dirfd:fd -> ?nofollow:bool-> sw:Switch.t -> string -> Flags.Open.t -> Flags.Disposition.t -> Flags.Create.t -> fd
(** Note: the returned FD is always non-blocking and close-on-exec. *)
|
