Module `Iobuf.Peek`Source

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.

Sourcetype 'seek src = (Core.read, 'seek) t

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

Source

module To_bytes : 
  Core.Blit.S1_distinct
    with type 'seek src := 'seek src
    with type _ dst := Core.Bytes.t

Source

module To_bigstring : 
  Core.Blit.S1_distinct
    with type 'seek src := 'seek src
    with type _ dst := Core.Bigstring.t

Sourcemodule To_string : sig ... end

Sourcetype ('a, 'd, 'w) t = ('d, 'w) t -> pos:int -> 'a

Sourcetype ('a, 'd, 'w) t_local = ('d, 'w) t -> pos:int -> 'a

Sourceval char : (char, 'd, 'w) t

Sourceval bin_prot : 'a Core.Bin_prot.Type_class.reader -> ('a, 'd, 'w) t

Sourceval int8 : (int, 'd, 'w) t

Sourceval int16_be : (int, 'd, 'w) t

Sourceval int16_le : (int, 'd, 'w) t

Sourceval int32_be : (int, 'd, 'w) t

Sourceval int32_le : (int, 'd, 'w) t

Sourceval int64_be_exn : (int, 'd, 'w) t

Sourceval int64_le_exn : (int, 'd, 'w) t

Sourceval int64_be_trunc : (int, 'd, 'w) t

Sourceval int64_le_trunc : (int, 'd, 'w) t

Sourceval uint8 : (int, 'd, 'w) t

Sourceval uint16_be : (int, 'd, 'w) t

Sourceval uint16_le : (int, 'd, 'w) t

Sourceval uint32_be : (int, 'd, 'w) t

Sourceval uint32_le : (int, 'd, 'w) t

Sourceval uint64_be_exn : (int, 'd, 'w) t

Sourceval uint64_le_exn : (int, 'd, 'w) t

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

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

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

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

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

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

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

Sourceval stringo : ?str_pos:int -> ?len:int -> (string, 'd, 'w) t

Sourceval byteso : ?str_pos:int -> ?len:int -> (Core.Bytes.t, 'd, 'w) t

Sourceval bigstringo : ?str_pos:int -> ?len:int -> (Core.Bigstring.t, 'd, 'w) t

Sourcemodule Local : sig ... end

Sourcemodule Int_repr : sig ... end

Source

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

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module `Iobuf.Peek`Source

package core_kernel

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module Iobuf.PeekSource

Module `Iobuf.Peek`Source