Peek (core_kernel.core_kernel.iobuf.Iobuf.Peek)

Module Iobuf.Peek

Peek and Poke functions access a value at pos from the lower bound of the window and do not advance.

Peek.bin_prot X.bin_read_t t returns the initial X.t in t without advancing.

Following the bin_prot protocol, the representation of x is X.bin_size_t x bytes long. Peek., Poke., Consume., and Fill.bin_prot do not add any size prefix or other framing to the bin_prot representation.

type ('seek, 'loc) src = (Core.read, 'seek, 'loc) t

Similar to Consume.To_*, but do not advance the buffer.

module To_bytes : 
  Core.Blit.S1_phantom2_distinct
    with type (_, 'seek, 'loc) src := ('seek, 'loc) src
    with type (_, _, _) dst := Core.Bytes.t

module To_bigstring : 
  Core.Blit.S1_phantom2_distinct
    with type (_, 'seek, 'loc) src := ('seek, 'loc) src
    with type (_, _, _) dst := Core.Bigstring.t

module To_string : sig ... end

type ('a, 'd, 'w, 'l) t = ('d, 'w, 'l) t @ local -> (pos:int -> 'a) @ local

type ('a, 'd, 'w, 'l) t__local =
  ('d, 'w, 'l) t @ local ->
  (pos:int ->
  'a @ local) @ local

val char : (char, 'd, 'w, 'l) t

val int8 : (int, 'd, 'w, 'l) t

val int16_be : (int, 'd, 'w, 'l) t

val int16_le : (int, 'd, 'w, 'l) t

val int32_be : (int, 'd, 'w, 'l) t

val int32_le : (int, 'd, 'w, 'l) t

val int64_be_exn : (int, 'd, 'w, 'l) t

val int64_le_exn : (int, 'd, 'w, 'l) t

val int64_be_trunc : (int, 'd, 'w, 'l) t

val int64_le_trunc : (int, 'd, 'w, 'l) t

val uint8 : (int, 'd, 'w, 'l) t

val uint16_be : (int, 'd, 'w, 'l) t

val uint16_le : (int, 'd, 'w, 'l) t

val uint32_be : (int, 'd, 'w, 'l) t

val uint32_le : (int, 'd, 'w, 'l) t

val uint64_be_exn : (int, 'd, 'w, 'l) t

val uint64_le_exn : (int, 'd, 'w, 'l) t

val int64_t_be : (Core.Int64.t, 'd, 'w, 'l) t

val int64_t_le : (Core.Int64.t, 'd, 'w, 'l) t

val head_padded_fixed_string : 
  padding:char ->
  len:int ->
  (string, 'd, 'w, 'l) t

val tail_padded_fixed_string : 
  padding:char ->
  len:int ->
  (string, 'd, 'w, 'l) t

val string : str_pos:int -> len:int -> (string, 'd, 'w, 'l) t

val bytes : str_pos:int -> len:int -> (Core.Bytes.t, 'd, 'w, 'l) t

val bigstring : str_pos:int -> len:int -> (Core.Bigstring.t, 'd, 'w, 'l) t

val stringo : 
  ?str_pos:int @ local ->
  (?len:int @ local ->
  (string, 'd, 'w, 'l) t @ local) @ local

val byteso : 
  ?str_pos:int @ local ->
  (?len:int @ local ->
  (Core.Bytes.t, 'd, 'w, 'l) t @ local) @ local

val bigstringo : 
  ?str_pos:int @ local ->
  (?len:int @ local ->
  (Core.Bigstring.t, 'd, 'w, 'l) t @ local) @ local

module Local : sig ... end

module Int_repr : sig ... end

val index : 
  ([> Core.read ], _, _) t @ local ->
  (?pos:int ->
  (?len:int ->
  (char ->
  int option) @ local) @ local) @ local

index ?pos ?len t c returns Some i for the smallest i >= pos such that char t i = c, or None if there is no such i.

parameter pos
default = 0

parameter len
default = length t - pos

val rindex : 
  ([> Core.read ], _, _) t @ local ->
  (?pos:int ->
  (?len:int ->
  (char ->
  int option) @ local) @ local) @ local

rindex ?pos ?len t c returns Some i for the largest i >= pos such that char t i = c, or None if there is no such i.

parameter pos
default = 0

parameter len
default = length t - pos