iostream 0.2 · OCaml Package

Input stream.

class type t = object ... end

An input stream, i.e an incoming stream of bytes.

class type t_seekable = object ... end

An input stream that is also seekable.

val create : 
  ?close:(unit -> unit) ->
  input:(bytes -> int -> int -> int) ->
  unit ->
  t

class empty : t

val empty : t

Empty input, contains 0 bytes.

class of_in_channel : ?close_noerr:bool -> in_channel -> t_seekable

val of_in_channel : ?close_noerr:bool -> in_channel -> t_seekable

Wrap a standard input channel.

class open_file : ?close_noerr:bool -> ?mode:int -> ?flags:open_flag list -> string -> 
  t_seekable

val open_file : 
  ?close_noerr:bool ->
  ?mode:int ->
  ?flags:open_flag list ->
  string ->
  t_seekable

val with_open_file : 
  ?close_noerr:bool ->
  ?mode:int ->
  ?flags:open_flag list ->
  string ->
  (t_seekable -> 'a) ->
  'a

class of_string : ?off:int -> ?len:int -> string -> t_seekable

val of_string : ?off:int -> ?len:int -> string -> t_seekable

An input channel reading from the string.

parameter len
the length of the slice we read from. Default String.length s - off.

class of_bytes : ?off:int -> ?len:int -> bytes -> t_seekable

val of_bytes : ?off:int -> ?len:int -> bytes -> t_seekable

An input channel reading from the bytes buffer. See of_string for more details.

val input : t -> bytes -> int -> int -> int

Read bytes into the given buffer. This returns 0 only if the stream has reached its end.

val input_all_into_buffer : t -> Buffer.t -> unit

Read the whole content into the given buffer.

val input_all : ?buf:bytes -> t -> string

input_all ic reads the whole content of ic into a string.

val really_input : t -> bytes -> int -> int -> unit

Same as input, but reads exactly the demanded amount of bytes.

val really_input_string : t -> int -> string

really_input_string ic n reads exactly n bytes of ic and returns them as a string.

val concat : t list -> t

Read from each stream, in order

val close : t -> unit

Close the input stream. This is idempotent.

val copy_into : ?buf:bytes -> t -> Out.t -> unit

Copy the whole stream into the given output.

val map_char : (char -> char) -> t -> t

Transform the stream byte by byte

package iostream