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_buf/index.html

Module Iostream.In_bufSource

Buffered input stream.

Sourceclass type t = object ... end

The implementation of buffered input streams.

Sourceclass virtual t_from_refill : ?bytes:bytes -> unit -> object ... end

A mixin to implement a buffered input by only providing a refill method. Add a close method and it's good to go.

Sourceval create : ?bytes:bytes -> ?close:(unit -> unit) -> refill:(bytes -> int) -> unit -> t

Create a new buffered input stream.

  • parameter refill

    will be called to refill the content of the bytes, returning how many bytes were added (starting at offset 0).

  • parameter buf

    the underlying buffer

Sourceclass of_bytes : ?off:int -> ?len:int -> bytes -> t
Sourceval of_bytes : ?off:int -> ?len:int -> bytes -> t
Sourceclass of_string : ?off:int -> ?len:int -> string -> t
Sourceval of_string : ?off:int -> ?len:int -> string -> t
Sourceclass bufferized : ?bytes:bytes -> In.t -> t
Sourceval bufferized : ?bytes:bytes -> In.t -> t

Read from the given buffer.

  • parameter off

    initial offset (default 0)

  • parameter len

    length of the slice in the bytes. (default all available bytes from offset)

Sourceclass of_in_channel : ?bytes:bytes -> in_channel -> t
Sourceval of_in_channel : ?bytes:bytes -> in_channel -> t

Wrap a standard input channel.

Sourceclass open_file : ?bytes:bytes -> ?mode:int -> ?flags:open_flag list -> string -> t
Sourceval open_file : ?bytes:bytes -> ?mode:int -> ?flags:open_flag list -> string -> t
Sourceval with_open_file : ?bytes:bytes -> ?mode:int -> ?flags:open_flag list -> string -> (t -> 'a) -> 'a
Sourceval fill_buf : t -> Slice.t

fill_buffer bic returns a slice into bic's internal buffer, and ensures it's empty only if bic.ic is empty.

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

Read into the given slice of bytes.

Sourceval of_in : ?bytes:bytes -> In.t -> t

Make a buffered version of the input stream.

  • parameter bytes

    the buffer to use.

Sourceval consume : t -> int -> unit

consume bic n consumes n bytes from bic. Precondition: n <= get_len bic, ie. one cannot consume bytes that have not yet been obtained via fill_buffer or fill_and_get.

Sourceval close : t -> unit

Close the input stream.

Sourceval into_in : t -> In.t

Cast into a In.t. This doesn't allocate.

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

Read the whole content into the given buffer.

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 copy_into : t -> Out.t -> unit

Copy the entire stream into the given output.

Sourceval skip : t -> int -> unit

skip ic n reads and dicards the next n bytes in ic.

Sourceval input_line : ?buffer:Buffer.t -> t -> string option

Read a line from the input. Return None if the stream is empty.

  • parameter buffer

    a buffer to use to hold the line.

Sourceval input_lines : ?buffer:Buffer.t -> t -> string list

Read all lines from the input.

Sourceval to_iter : t -> (char -> unit) -> unit
Sourceval to_seq : t -> char Seq.t
Sourceval of_seq : ?bytes:bytes -> char Seq.t -> t