package core

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

See Iobuf for documentation.

no_seek and seek are phantom types used in a similar manner to read and read_write.

type no_seek

Like read.

val sexp_of_no_seek : no_seek -> Ppx_sexp_conv_lib.Sexp.t
type seek = private no_seek

Like read_write.

val sexp_of_seek : seek -> Ppx_sexp_conv_lib.Sexp.t
module type Accessors_common = sig ... end

Collections of access functions. These abstract over Iobuf.Consume, Iobuf.Fill, Iobuf.Peek, and Iobuf.Poke.

module type Accessors_read = sig ... end
module type Accessors_write = sig ... end
module type Bound = sig ... end

An iobuf window bound, either upper or lower. You can't see its int value, but you can save and restore it.

The src_pos argument of Core_kernel.Blit.blit doesn't make sense here.

type ('src, 'dst) consuming_blit = src:'src -> dst:'dst -> dst_pos:int -> len:int -> unit
type ('src, 'dst) consuming_blito = src:'src -> ?src_len:int -> dst:'dst -> ?dst_pos:int -> unit -> unit
module type Consuming_blit = sig ... end
module type Compound_hexdump = sig ... end
module Unix : sig ... end

This file is a modified version of unixLabels.mli from the OCaml distribution. Many of these functions raise exceptions but do not have a _exn suffixed name.

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