Module Stdune.Io

IO operations.

val close_in : in_channel -> unit
val close_out : out_channel -> unit
val close_both : (in_channel * out_channel) -> unit
val input_lines : in_channel -> string list
val copy_channels : in_channel -> out_channel -> unit
val read_all_unless_large : in_channel -> (string, unit) result

Try to read everything from a channel. Returns Error () if the contents are larger than Sys.max_string_length. This is generally a problem only on 32-bit systems. Overflow detection does not happen in the following cases:

  • channel is not a file (for example, a pipe)
  • if the detected size is unreliable (/proc)
  • race condition with another process changing the size of the underlying file. In these cases, an exception might be raised by Buffer functions.
type path = Path.t
val open_in : ?binary:bool -> path -> in_channel
val open_out : ?binary:bool -> ?perm:int -> path -> out_channel
val with_file_in : ?binary:bool -> path -> f:(in_channel -> 'a) -> 'a
val with_file_out : ?binary:bool -> ?perm:int -> path -> f:(out_channel -> 'a) -> 'a
val with_lexbuf_from_file : path -> f:(Lexing.lexbuf -> 'a) -> 'a
val lines_of_file : path -> string list
val zero_strings_of_file : path -> string list

Reads zero-separated strings from a file

val read_file : ?binary:bool -> path -> string
val write_file : ?binary:bool -> ?perm:int -> path -> string -> unit
val compare_files : path -> path -> Ordering.t
val compare_text_files : path -> path -> Ordering.t
val write_lines : ?binary:bool -> ?perm:int -> path -> string list -> unit
val copy_file : ?chmod:(int -> int) -> src:path -> dst:path -> unit -> unit
val setup_copy : ?chmod:(int -> int) -> src:path -> dst:path -> unit -> in_channel * out_channel
val file_line : path -> int -> string
val file_lines : path -> start:int -> stop:int -> (string * string) list
val cat : ?binary:bool -> ?dst:out_channel -> path -> unit

reads a file and prints its contents to stdout or the specified channel

module String_path : sig ... end

Symlink with fallback to copy on systems that don't support it.

Hardlink with fallback to copy on systems that don't support it.

val set_copy_impl : [ `Portable | `Best ] -> unit