package eio
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=d84847ce85ffb78641496ad24be3c6ab5cc2c6885cedad6ae257ecac59d926a0
sha512=fbcbc8e7e8eaaeacd6c7b3be04fec19b356f900307b2cc1bf6c1cd6bd538c4ea59ab2c7d936fac00c52a3277737671759f1584025c24e0a7727447609c633821
doc/eio.unix/Eio_unix/Fd/index.html
Module Eio_unix.FdSource
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 ->
tof_unix ~sw ~close_unix fd wraps fd.
of_unix_list ~sw fds is like List.map (of_unix ~sw ~close_unix:true) fds, except that if sw is off then it closes all the FDs.
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).