package luv

  1. Overview
  2. Docs
package luv
Legend:
Library
Module
Module type
Parameter
Class
Class type

Filesystem polling.

See uv_fs_poll_t — FS Poll handle in libuv.

type t = [ `FS_poll ] Handle.t

Binds uv_fs_poll_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.

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

Allocates and initializes an FS polling handle.

Binds uv_fs_poll_init.

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

val start : ?interval:int -> t -> string -> ((File.Stat.t * File.Stat.t, Error.t) Result.result -> unit) -> unit

Starts the handle and polls the given path for changes.

Binds uv_fs_poll_start.

The default value of ?interval is 2000 (milliseconds).

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

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

Stops the handle.

Binds uv_fs_poll_stop.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct