package luv

  1. Overview
  2. Docs
Binding to libuv: cross-platform asynchronous I/O

Install 

dune-project
 Dependency

github.com Readme MIT License Edit opam file Versions (15)

Authors

  1. Anton Bachin

Maintainers

  1. Anton Bachin

Sources

luv-0.5.6.tar.gz
sha256=35d8092d7a7e8d00a7ab8caf79d99e2073baf1999f5b9274de4d69078ad83685
md5=fb78fd1b179f5c9585e79b5a1c5ff644

doc/luv/Luv/FS_event/index.html

Module Luv.FS_eventSource

Filesystem events.

See File change events in the user guide and uv_fs_event_t — FS Event handle in libuv.

Sourcetype t = [ `FS_event ] Handle.t

Binds uv_fs_event_t.

Note that values of this type can be passed to functions in Luv.Handle, in addition to the functions in this module. In particular, see Luv.Handle.close.

Sourcemodule Event : sig ... end

Binds uv_fs_event.

Sourceval init : ?loop:Loop.t -> unit -> (t, Error.t) Result.result

Allocates and initializes an FS event handle.

Binds uv_fs_event_init.

The handle should be cleaned up with Luv.Handle.close when no longer needed.

Sourceval start : ?watch_entry:bool -> ?stat:bool -> ?recursive:bool -> t -> string -> ((string * Event.t list, Error.t) Result.result -> unit) -> unit

Starts the handle and watches the given path for changes.

Binds uv_fs_event_start.

uv_fs_event_start takes a flags argument of type uv_fs_event_flags. Luv.FS_event.start instead takes several optional arguments, each named after one of the flags.

See uv_fs_event_cb for a description of the values passed to the callback.

Sourceval stop : t -> (unit, Error.t) Result.result

Stops the handle.

Binds uv_fs_event_stop.