package iostream

  1. Overview
  2. Docs

Output stream.

class type t = object ... end

An output stream, ie. a place into which we can write bytes. This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

class type t_seekable = object ... end
class dummy : t
val dummy : t

Dummy output, drops everything written to it.

class of_out_channel : ?close_noerr:bool -> Stdlib.out_channel -> t_seekable
val of_out_channel : ?close_noerr:bool -> Stdlib.out_channel -> t_seekable

Wrap an out channel.

class of_buffer : Stdlib.Buffer.t -> t
val of_buffer : Stdlib.Buffer.t -> t

of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.

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

open_file file creates an out stream writing into the given file.

  • parameter mode

    permissions for the file creation

  • parameter flags

    set of unix flags to use. It must contain write permissions.

val with_open_file : ?close_noerr:bool -> ?mode:int -> ?flags:Stdlib.open_flag list -> string -> (t_seekable -> 'a) -> 'a
val output : t -> bytes -> int -> int -> unit

Write the slice of bytes.

val close : t -> unit

Close the stream. Idempotent.

val output_string : t -> string -> unit

Output the whole string.

val output_int : t -> int -> unit

Output an integer in decimal notation.

val tee : t list -> t

tee ocs is an output that accepts bytes and writes them to every output in ocs. When closed, it closes all elements of oc.

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

Transform the stream byte by byte


Innovation. Community. Security.