Expert (core_kernel.core_kernel.iobuf.Iobuf.Expert)

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 buf : (_, _, Core.Modes.At_locality.global) t @ local -> Core.Bigstring.t

val hi_max : (_, _, _) t @ local -> int

val hi : (_, _, _) t @ local -> int

val lo : (_, _, _) t @ local -> int

val lo_min : (_, _, _) t @ local -> int

val set_buf : (_, _, _) t @ local -> (Core.Bigstring.t -> unit) @ local

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

val set_hi_max : (_, _, _) t @ local -> (int -> unit) @ local

val set_hi : (_, _, _) t @ local -> (int -> unit) @ local

val set_lo : (_, _, _) t @ local -> (int -> unit) @ local

val set_lo_min : (_, _, _) t @ local -> (int -> unit) @ local

val to_bigstring_shared : 
  ?pos:int ->
  ?len:int ->
  (_, _, Core.Modes.At_locality.global) t @ local ->
  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 @ local ->
  (pos:int ->
  (len:int ->
  (Core.Bigstring.t ->
  unit) @ local) @ local) @ local

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 @ local ->
  (lo_min:int ->
  (lo:int ->
  (hi:int ->
  (hi_max:int ->
  (Core.Bigstring.t ->
  unit) @ local) @ local) @ local) @ local) @ local

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

val set_bounds_and_buffer : 
  src:('data, _, Core.Modes.At_locality.global) t @ local ->
  (dst:('data, Iobuf__.Iobuf_type_intf.Definitions.no_seek, _) t @ local ->
  unit) @ local

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, _, Core.Modes.At_locality.global) t @ local ->
  (dst:('data, Iobuf__.Iobuf_type_intf.Definitions.no_seek, _) t @ local ->
  unit) @ local

val protect_window : 
  ('rw, _, 'loc) t @ local ->
  (f:
     (('rw, Iobuf__.Iobuf_type_intf.Definitions.no_seek, 'loc) t @ local -> 'a) @ local ->
  'a) @ local

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, _, 'loc) t ->
  f:(('rw, Iobuf__.Iobuf_type_intf.Definitions.no_seek, 'loc) t -> 'a) @ local ->
  '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, _, 'loc) t @ local ->
  ('a ->
  (f:
     (('rw, Iobuf__.Iobuf_type_intf.Definitions.no_seek, 'loc) t @ local ->
       ('a ->
       'b) @ local) @ local ->
  'b) @ local) @ local

val protect_window_1_global_deprecated : 
  ('rw, _, 'loc) t ->
  'a ->
  f:
    (('rw, Iobuf__.Iobuf_type_intf.Definitions.no_seek, 'loc) t ->
      ('a ->
      'b) @ local) @ local ->
  'b

val protect_window_2 : 
  ('rw, _, 'loc) t @ local ->
  ('a ->
  ('b ->
  (f:
     (('rw, Iobuf__.Iobuf_type_intf.Definitions.no_seek, 'loc) t @ local ->
       ('a ->
       ('b ->
       'c) @ local) @ local) @ local ->
  'c) @ local) @ local) @ local

val protect_window_2_global_deprecated : 
  ('rw, _, 'loc) t ->
  'a ->
  'b ->
  f:
    (('rw, Iobuf__.Iobuf_type_intf.Definitions.no_seek, 'loc) t ->
      ('a ->
      ('b ->
      'c) @ local) @ local) @ local ->
  'c

val protect_window__local : 
  'a 'rw 'sk 'loc. ('rw, 'sk, 'loc) t @ local ->
  (f:
     (('rw, Iobuf__.Iobuf_type_intf.Definitions.no_seek, 'loc) t @ local ->
       'a @ local) @ local ->
  'a @ local) @ local

Similar to protect_window but returns a local value.

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

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

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

As buf_pos_exn without checks.