Source file io_intf.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
module type S = sig
  type path

  val open_in : ?binary:bool (* default true *) -> path -> in_channel
  val open_out : ?binary:bool (* default true *) -> ?perm:int -> path -> out_channel
  val with_file_in : ?binary:bool (* default true *) -> path -> f:(in_channel -> 'a) -> 'a

  val with_file_out
    :  ?binary:bool (* default true *)
    -> ?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

  (** Reads zero-separated strings from a file *)
  val zero_strings_of_file : path -> string list

  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

  (** reads a file and prints its contents to stdout or the specified channel *)
  val cat : ?binary:bool (* default true *) -> ?dst:out_channel -> path -> unit
end