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 in 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 Core_kernel.Flags.S with type t := t
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Typerep_lib.Typerepable.S with type t := t
val typerep_of_t : t Typerep_lib.Std_internal.Typerep.t
val typename_of_t : t Typerep_lib.Typename.t

consistent with subset

include Core_kernel.Comparable.S with type t := t
include Base.Comparable.S 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
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val comparator : (t, comparator_witness) Base__.Comparator.comparator
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
module Replace_polymorphic_compare : sig ... end
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 is_subset : t -> of_:t -> Base.Bool.t

is_subset t ~of_ is t = intersect t of_

module Unstable : sig ... end

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 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