File manipulation

This is a guide to basic file manipulation in OCaml using only what the standard library provides.

Official documentation for the modules of interest: Pervasives, Printf.

The standard library doesn't provide functions that directly read a file into a string or save a string into a file. Such functions can be found in third-party libraries such as Extlib. See Std.input_file and Std.output_file.

Buffered channels

The normal way of opening a file in OCaml returns a channel. There are two kinds of channels:


For writing into a file, you would do this:

  1. Open the file to obtain an out_channel
  2. Write stuff to the channel
  3. If you want to force writing to the physical device, you must flush the channel, otherwise writing will not take place immediately.
  4. When you are done, you can close the channel. This flushes the channel automatically.

Commonly used functions: open_out, open_out_bin, flush, close_out, close_out_noerr

Standard out_channels: stdout, stderr


For reading data from a file you would do this:

  1. Open the file to obtain an in_channel
  2. Read characters from the channel. Reading consumes the channel, so if you read a character, the channel will point to the next character in the file.
  3. When there are no more characters to read, the End_of_file exception is raised. Often, this is where you want to close the channel.

Commonly used functions: open_in, open_in_bin, close_in, close_in_noerr

Standard in_channel: stdin


Whenever you write or read something to or from a channel, the current position changes to the next character after what you just wrote or read. Occasionally, you may want to skip to a particular position in the file, or restart reading from the beginning. This is possible for channels that point to regular files, use seek_in or seek_out.



open Printf

let file = "example.dat"
let message = "Hello!"

let _ =

  (* Write message to file *)
  let oc = open_out file in    (* create or truncate file, return channel *)
  fprintf oc "%s\n" message;   (* write something *)   
  close_out oc;                (* flush and close the channel *)

  (* Read file and display the first line *)
  let ic = open_in file in
    let line = input_line ic in  (* read line from in_channel and discard \n *)
    print_endline line;          (* write the result to stdout *)
    flush stdout;                (* write on the underlying device now *)
    close_in ic                  (* close the input channel *) 

  with e ->                      (* some unexpected exception occurs *)
    close_in_noerr ic;           (* emergency closing *)
    raise e                      (* exit with error: files are closed but
                                    channels are not flushed *)

  (* normal exit: all channels are flushed and closed *)