package core_kernel

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

The Expert module is for building efficient out-of-module Iobuf abstractions.

val buf : (_, _) t -> Core.Bigstring.t

These accessors will not allocate, and are mainly here to assist in building low-cost syscall wrappers.

One must be careful to avoid writing out of the limits (between lo_min and hi_max) of the buf. Doing so would violate the invariants of the parent Iobuf.

val hi_max : (_, _) t -> int
val hi : (_, _) t -> int
val lo : (_, _) t -> int
val lo_min : (_, _) t -> int
val set_buf : (_, _) t -> Core.Bigstring.t -> unit

These setters directly set fields in t without checking any invariants.

val set_hi_max : (_, _) t -> int -> unit
val set_hi : (_, _) t -> int -> unit
val set_lo : (_, _) t -> int -> unit
val set_lo_min : (_, _) t -> int -> unit
val to_bigstring_shared : ?pos:int -> ?len:int -> (_, _) t -> Core.Bigstring.t

to_bigstring_shared t and to_iobuf_shared t allocate new wrappers around the storage of buf t, relative to t's current bounds.

These operations allow access outside the bounds and limits of t, and without respect to its read/write access. Be careful not to violate t's invariants.

val reinitialize_of_bigstring : (_, _) t -> pos:int -> len:int -> Core.Bigstring.t -> unit

reinitialize_of_bigstring t bigstring reinitializes t with backing bigstring, and the window and limits specified starting at pos and of length len.

val unsafe_reinitialize : (_, _) t -> lo_min:int -> lo:int -> hi:int -> hi_max:int -> Core.Bigstring.t -> unit

As reinitialize_of_bigstring but without checking, and requires explicit specification of bounds.

val set_bounds_and_buffer : src:('data, _) t -> dst:('data, seek) t -> unit

These versions of set_bounds_and_buffer allow ~src to be read-only. ~dst will be writable through ~src aliases even though the type does not reflect this!

val set_bounds_and_buffer_sub : pos:int -> len:int -> src:('data, _) t -> dst:('data, seek) t -> unit
val protect_window : ('rw, _) t -> f:(('rw, seek) t -> 'a) -> 'a

Similar to protect_window_bounds_and_buffer, but does not save/restore the buffer or bounds. Mixing this with functions like set_bounds_and_buffer or narrow is unsafe; you should not modify anyything but the window inside f.

val protect_window_global_deprecated : ('rw, _) t -> f:(('rw, seek) t -> 'a) -> 'a

As protect_window but does not enforce that the closure should not let the buffer escape. Letting the buffer escape is dangerous and almost certainly not what you wanted.

val protect_window_1 : ('rw, _) t -> 'a -> f:(('rw, seek) t -> 'a -> 'b) -> 'b
val protect_window_1_global_deprecated : ('rw, _) t -> 'a -> f:(('rw, seek) t -> 'a -> 'b) -> 'b
val protect_window_2 : ('rw, _) t -> 'a -> 'b -> f:(('rw, seek) t -> 'a -> 'b -> 'c) -> 'c
val protect_window_2_global_deprecated : ('rw, _) t -> 'a -> 'b -> f:(('rw, seek) t -> 'a -> 'b -> 'c) -> 'c
val protect_window_local : ('rw, _) t -> f:(('rw, seek) t -> 'a) -> 'a

Similar to protect_window but returns a local value.

val buf_pos_exn : (_, _) t -> pos:int -> len:int -> int

Computes the position within buf for pos relative to our window. Checks len bytes are available.

val unsafe_buf_pos : (_, _) t -> pos:int -> len:int -> int

As buf_pos_exn without checks.

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