package core_kernel

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (10)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

core_kernel-v0.15.0.tar.gz
sha256=34a0288f16027c6b90e4ad16cb5cc677d7063d310faf918748ce70f1745116c0

doc/core_kernel.iobuf/Iobuf/Peek/index.html

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 src = (Core.read, 'seek) t

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

module To_bytes : Core.Blit.S1_distinct with type 'seek src := 'seek src with type _ dst := Core.Bytes.t
module To_bigstring : Core.Blit.S1_distinct with type 'seek src := 'seek src with type _ dst := Core.Bigstring.t
module To_string : sig ... end
type ('a, 'd, 'w) t = ('d, 'w) t -> pos:int -> 'a
val char : (char, 'd, 'w) t
val int64_t_be : (Core.Int64.t, 'd, 'w) t
val int64_t_le : (Core.Int64.t, 'd, 'w) t
val head_padded_fixed_string : padding:char -> len:int -> (string, 'd, 'w) t
val tail_padded_fixed_string : padding:char -> len:int -> (string, 'd, 'w) t
val string : str_pos:int -> len:int -> (string, 'd, 'w) t
val bytes : str_pos:int -> len:int -> (Core.Bytes.t, 'd, 'w) t
val bigstring : str_pos:int -> len:int -> (Core.Bigstring.t, 'd, 'w) t
val stringo : ?str_pos:int -> ?len:int -> (string, 'd, 'w) t
val byteso : ?str_pos:int -> ?len:int -> (Core.Bytes.t, 'd, 'w) t
val bigstringo : ?str_pos:int -> ?len:int -> (Core.Bigstring.t, 'd, 'w) t
val bin_prot : 'a Core.Bin_prot.Type_class.reader -> ('a, 'd, 'w) t
val int8 : (int, 'd, 'w) t
val int16_be : (int, 'd, 'w) t
val int16_le : (int, 'd, 'w) t
val int32_be : (int, 'd, 'w) t
val int32_le : (int, 'd, 'w) t
val int64_be_exn : (int, 'd, 'w) t
val int64_le_exn : (int, 'd, 'w) t
val int64_be_trunc : (int, 'd, 'w) t
val int64_le_trunc : (int, 'd, 'w) t
val uint8 : (int, 'd, 'w) t
val uint16_be : (int, 'd, 'w) t
val uint16_le : (int, 'd, 'w) t
val uint32_be : (int, 'd, 'w) t
val uint32_le : (int, 'd, 'w) t
val uint64_be_exn : (int, 'd, 'w) t
val uint64_le_exn : (int, 'd, 'w) t
module Int_repr : sig ... end
val index : ([> Core.read ], _) iobuf -> ?pos:int -> ?len:int -> char -> int option

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