Read (regular.Regular.Std.Data.Read)

type 'a t = 'a reader

readable

val create : 
  ?of_channel:(Core_kernel.In_channel.t -> 'a) ->
  ?of_lexbuf:(lexbuf -> 'a) ->
  ?of_scanbuf:(scanbuf -> 'a) ->
  ?of_bigstring:(Core_kernel.bigstring -> 'a) ->
  ?of_bytes:(bytes -> 'a) ->
  unit ->
  'a t

A minimal complete definition is any method except of_channel (that is not sufficient).

If a class is defined only with from_bigstring or from_bytes then from_channel function will consume all input and pass it to the correspondings function.

val of_bytes : 'a t -> bytes -> 'a

of_bytes readable bytes reads a value from bytes

val of_channel : 'a t -> Core_kernel.In_channel.t -> 'a

of_channel readable channel inputs a value from a channel. If of_channel function wasn't provided when readable was created, then the whole content of the In_channel.t is read into an intermediate buffer, that is later read. Any leftover bytes are discarded.

val of_bigstring : 'a t -> Core_kernel.bigstring -> 'a

of_bigstring readable buf deserializes a readable value from the bigstring.