Module Stdune.IoSource

IO operations.

Sourceval close_in : in_channel -> unit
Sourceval close_out : out_channel -> unit
Sourceval close_both : (in_channel * out_channel) -> unit
Sourceval input_lines : in_channel -> string list
Sourceval copy_channels : in_channel -> out_channel -> unit
Sourceval 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.
Sourcetype path = Path.t
Sourceval open_in : ?binary:bool -> path -> in_channel
Sourceval open_out : ?binary:bool -> ?perm:int -> path -> out_channel
Sourceval with_file_in : ?binary:bool -> path -> f:(in_channel -> 'a) -> 'a
Sourceval with_file_out : ?binary:bool -> ?perm:int -> path -> f:(out_channel -> 'a) -> 'a
Sourceval with_lexbuf_from_file : path -> f:(Lexing.lexbuf -> 'a) -> 'a
Sourceval lines_of_file : path -> string list
Sourceval zero_strings_of_file : path -> string list

Reads zero-separated strings from a file

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

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

Sourcemodule 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.