package core

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

An Epoll.Flags.t is an immutable set of flags for which one can register interest for a file descriptor. It is implemented as a bitmask, and so all operations (+, -, etc.) are constant time with no allocation.

sexp_of_t produces a human-readable list of bits, e.g. "(in out)".

include sig ... end
include Core_kernel.Flags.S with type t := t
include sig ... end
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
val typerep_of_t : t Typerep_lib.Std.Typerep.t
val typename_of_t : t Typerep_lib.Std.Typename.t

consistent with subset

include Core_kernel.Comparable.S with type t := t
include Base.Comparable_intf.S with type t := t
include Base.Comparable_intf.Polymorphic_compare with type t := t
include Base.Polymorphic_compare_intf.Infix with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int

-1 means "less than", 0 means "equal", 1 means "greater than", and other values should not be returned

val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~cmp:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
type comparator_witness
include Base.Comparable_intf.Validate with type t := t
val validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
val of_int : Base.Int.t -> t
val to_int_exn : t -> Base.Int.t
val empty : t
val (+) : t -> t -> t

set union, bitwise or

val (-) : t -> t -> t

set difference

val intersect : t -> t -> t

bitwise and

val complement : t -> t

bitwise not

val is_empty : t -> Base.Bool.t
val do_intersect : t -> t -> Base.Bool.t
val are_disjoint : t -> t -> Base.Bool.t
val subset : t -> t -> Base.Bool.t

subset a b = is_empty (a - b)

The names of the flags match the man pages. E.g. in_ = "EPOLLIN", out = "EPOLLOUT", etc.

val none : t

Associated fd is readable

val in_ : t

Associated fd is readable

val out : t

Associated fd is writable

val pri : t

Urgent data available

val err : t

Error condition (always on, no need to set it)

val hup : t

Hang up happened (always on)

val et : t

Edge Triggered behavior (see man page)

val oneshot : t

one-shot behavior for the associated fd

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events Blog 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