package eio
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=390f7814507b8133d6c25e3a67a742d731c7ca66252b287b1fb0e3ad4d10eecc
sha512=9c0c9088b178df9799aaae9deb803a802228f1329cbe452479c90e80a13985d9c364ea86ee14e4e759133940f9f6065c7e8ece509d176fb1e347c5320f00a494
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
).
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
).