Module Stdio__.Out_channel

type t = Caml.out_channel
val stdout : t
val stderr : t
type 'a with_create_args = ?binary:Stdio__.Import.bool ‑> ?append:Stdio__.Import.bool ‑> ?fail_if_exists:Stdio__.Import.bool ‑> ?perm:Stdio__.Import.int ‑> 'a
val create : (Stdio__.Import.string ‑> t) with_create_args
val with_file : (Stdio__.Import.string ‑> f:(t ‑> 'a) ‑> 'a) with_create_args
val close : t ‑> Stdio__.Import.unit

close t flushes and closes t, and may raise an exception. close returns () and does not raise if t is already closed. close raises an exception if the close() system call on the underlying file descriptor fails (i.e. returns -1), which would happen in the following cases:

EBADF -- this would happen if someone else did close() system call on the underlying fd, which I would think a rare event.

EINTR -- would happen if the system call was interrupted by a signal, which would be rare. Also, I think we should probably just catch EINTR and re-attempt the close. Unfortunately, we can't do that in OCaml because the OCaml library marks the out_channel as closed even if the close syscall fails, so a subsequent call close_out_channel will be a no-op. This should really be fixed in the OCaml library C code, having it restart the close() syscall on EINTR. I put a couple CRs in fixed_close_channel, our rework of OCaml's caml_ml_close_channel,

EIO -- I don't recall seeing this. I think it's rare.

See "man 2 close" for details.

val set_binary_mode : t ‑> Stdio__.Import.bool ‑> Stdio__.Import.unit
val flush : t ‑> Stdio__.Import.unit
val output : t ‑> buf:Stdio__.Import.string ‑> pos:Stdio__.Import.int ‑> len:Stdio__.Import.int ‑> Stdio__.Import.unit
val output_string : t ‑> Stdio__.Import.string ‑> Stdio__.Import.unit
val output_char : t ‑> Stdio__.Import.char ‑> Stdio__.Import.unit
val output_byte : t ‑> Stdio__.Import.int ‑> Stdio__.Import.unit
val output_binary_int : t ‑> Stdio__.Import.int ‑> Stdio__.Import.unit
val output_buffer : t ‑> Stdio__.Import.Buffer.t ‑> Stdio__.Import.unit
val output_value : t ‑> _ ‑> Stdio__.Import.unit

OCaml's internal Marshal format

val newline : t ‑> Stdio__.Import.unit
val output_lines : t ‑> Stdio__.Import.string Stdio__.Import.list ‑> Stdio__.Import.unit

Outputs a list of lines, each terminated by a newline character

val fprintf : t ‑> ('atStdio__.Import.unitStdio__.Import.format ‑> 'a

Formatted printing to an out channel. This is the same as Printf.sprintf except that it outputs to t instead of returning a string. Similarly, the function arguments corresponding to conversions specifications such as %a or %t takes t as argument and must print to it instead of returning a string.

val printf : ('atStdio__.Import.unitStdio__.Import.format ‑> 'a

printf fmt is the same as fprintf stdout fmt

val eprintf : ('atStdio__.Import.unitStdio__.Import.format ‑> 'a

printf fmt is the same as fprintf stderr fmt

val kfprintf : (t ‑> 'a) ‑> t ‑> ('btStdio__.Import.unit'aStdio__.Import.format4 ‑> 'b

kfprintf k t fmt is the same as fprintf t fmt, but instead of returning immediately, passes the out channel to k at the end of printing.

val print_endline : Stdio__.Import.string ‑> Stdio__.Import.unit

print_endline str outputs str to stdout followed by a newline then flushes stdout

val prerr_endline : Stdio__.Import.string ‑> Stdio__.Import.unit

prerr_endline str outputs str to stderr followed by a newline then flushes stderr

val seek : t ‑> Stdio__.Import.int64 ‑> Stdio__.Import.unit
val pos : t ‑> Stdio__.Import.int64
val length : t ‑> Stdio__.Import.int64
val write_lines : Stdio__.Import.string ‑> Stdio__.Import.string Stdio__.Import.list ‑> Stdio__.Import.unit

The first argument of these is the file name to write to.

val write_all : Stdio__.Import.string ‑> data:Stdio__.Import.string ‑> Stdio__.Import.unit