package iostream

  1. Overview
  2. Docs
Generic, composable IO input and output streams

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

  1. S
    Simon Cruanes

Maintainers

  1. S
    Simon Cruanes

Sources

iostream-0.2.1.tbz
sha256=09cd438f755d46bf10e986be0d3dd2ab243b1f5455c3c7410dcde8de521615a9
sha512=c5f4c251ba33386dd027d2cf340268d14fdbcd3119be6bac3586fd9ad1e9f90992ef12e8fd9fbf2442c6747560d84fd2461656ea639f818e53d0b08e82dd8e9a

doc/iostream/Iostream/In/index.html

Module Iostream.InSource

Input stream.

Sourceclass type t = object ... end

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

Sourceclass type t_seekable = object ... end

An input stream that is also seekable.

Sourceval create : ?close:(unit -> unit) -> input:(bytes -> int -> int -> int) -> unit -> t
Sourceclass empty : t
Sourceval empty : t

Empty input, contains 0 bytes.

Sourceclass of_in_channel : ?close_noerr:bool -> in_channel -> t_seekable
Sourceval of_in_channel : ?close_noerr:bool -> in_channel -> t_seekable

Wrap a standard input channel.

Sourceclass open_file : ?close_noerr:bool -> ?mode:int -> ?flags:open_flag list -> string -> t_seekable
Sourceval open_file : ?close_noerr:bool -> ?mode:int -> ?flags:open_flag list -> string -> t_seekable
Sourceval with_open_file : ?close_noerr:bool -> ?mode:int -> ?flags:open_flag list -> string -> (t_seekable -> 'a) -> 'a
Sourceclass of_string : ?off:int -> ?len:int -> string -> t_seekable
Sourceval of_string : ?off:int -> ?len:int -> string -> t_seekable

An input channel reading from the string.

  • parameter offset

    initial offset in the string. Default 0.

  • parameter len

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

Sourceclass of_bytes : ?off:int -> ?len:int -> bytes -> t_seekable
Sourceval of_bytes : ?off:int -> ?len:int -> bytes -> t_seekable

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

Sourceval input : t -> bytes -> int -> int -> int

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

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

Read the whole content into the given buffer.

  • since 0.2
Sourceval input_all : ?buf:bytes -> t -> string

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

  • parameter buf

    the initial buffer to use internally.

  • since 0.2
Sourceval really_input : t -> bytes -> int -> int -> unit

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

  • raises End_of_file

    if the input does not contain enough data.

  • since 0.2
Sourceval really_input_string : t -> int -> string

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

  • raises End_of_file

    if the input does not contain enough data.

  • since 0.2
Sourceval concat : t list -> t

Read from each stream, in order

Sourceval close : t -> unit

Close the input stream. This is idempotent.

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

Copy the whole stream into the given output.

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

Transform the stream byte by byte