package eio
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=0c33742074562631677886f4fe4a02f9672cec94297ff85c2ed854db5baa71aa
sha512=590843cb5fb3906fd5ab9911d29206172d164a53c48e635871a23c95d4cdce8ae0999480471187fdddee8c9c523148911ca140feabde6a826c317671a3b33090
doc/eio.unix/Eio_unix/Fd/index.html
Module Eio_unix.Fd
Source
A safe wrapper for Unix.file_descr
.
A wrapper around a Unix.file_descr
.
Creation
val of_unix :
sw:Eio.Std.Switch.t ->
?blocking:bool ->
?seekable:bool ->
close_unix:bool ->
Unix.file_descr ->
t
of_unix ~sw ~close_unix fd
wraps fd
.
Using FDs
use t fn ~if_closed
calls fn wrapped_fd
, ensuring that wrapped_fd
will not be closed before fn
returns.
If t
is already closed, it returns if_closed ()
instead.
use_exn op t fn
calls fn wrapped_fd
, ensuring that wrapped_fd
will not be closed before fn
returns.
If t
is already closed, it raises an exception, using op
as the name of the failing operation.
use_exn_list op fds fn
calls use_exn
on each FD in fds
, calling fn wrapped_fds
on the results.
Closing
close t
marks t
as closed, so that use
can no longer be used to start new operations.
The wrapped FD will be closed once all current users of the FD have finished (unless close_unix = false
).
Has no effect if t
is already closed.
remove t
marks t
as closed, so that use
can no longer be used to start new operations.
It then waits for all current users of the wrapped FD to finish using it, and then returns the FD.
This operation suspends the calling fiber and so must run from an Eio fiber. It does not allow itself to be cancelled, since it takes ownership of the FD and that would be leaked if it aborted.
Returns None
if t
is closed by another fiber first.
Flags
is_blocking t
returns the value of blocking
passed to of_unix
.
If not known, it first probes for it (and if the FD is already closed, returns false
).
is_seekable t
returns the value of seekable
passed to of_unix
.
If not known, it first probes for it (and if the FD is already closed, returns false
).