Module Core__Core_unix.Open_flags

type t

Open_flags.t represents the flags associated with a file descriptor in the open-file-descriptor table. It deals with the same thing as OCaml's open_flag type; however, it uses Core's Flags approach and the underlying integer bitmask representation, and so interoperates more smoothly with C.

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

consistent with subset

include Core_kernel.Comparable.S with type t := t
include Core_kernel__.Comparable_intf.S_common
include Base.Comparable_intf.S
include Base.Comparable_intf.Polymorphic_compare
include Base.Polymorphic_compare_intf.Infix
type 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 t
type comparator_witness
include Base.Comparable_intf.Validate with type t := t
type 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 : Core_kernel__.Import.int ‑> t
val to_int_exn : t ‑> Core_kernel__.Import.int
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 ‑> Core_kernel__.Import.bool
val do_intersect : t ‑> t ‑> Core_kernel__.Import.bool
val are_disjoint : t ‑> t ‑> Core_kernel__.Import.bool
val subset : t ‑> t ‑> Core_kernel__.Import.bool

subset a b = is_empty (a - b)

val rdonly : t

access mode.

These three flags are not individual bits like flags usually are. The access mode is represented by the lower two bits of the Open_flags.t. A particular Open_flags.t should include exactly one access mode. Combining different Open_flags.t's using flags operations (e.g +) is only sensible if they have the same access mode.

val wronly : t
val rdwr : t
val creat : t

creation

val excl : t
val noctty : t
val trunc : t
val append : t
val nonblock : t
val dsync : t
val sync : t
val rsync : t
val can_read : t ‑> bool

can_read t iff t has rdonly or rdwr

val can_write : t ‑> bool

can_read t iff t has wronly or rdwr