Module Unixutil

module Unixutil: sig  end

Unix utilities.

This module provides various helpful utilities for use with the built-in Unix module.
Author(s): Copyright (C) 2004 John Goerzen

val exists : string -> bool

Returns true if the specified file exists; false otherwise.

val list_of_dir : string -> string list

Returns a list of all entries, exclusive of "." and "..", in the specified directory.

val fold_directory : ('a -> string -> 'a) -> 'a -> string -> 'a

Folds over the specified directory

val recurse_stream : string -> (string * Unix.stats) Stream.t

recurse_stream name

will create a stream that yields a (stats, name) pair for every entry beneath the given filename (including the filename itself. It's a depth-first traversal.

The stats are included because a lot of people want to check on the type of file for each file in the list. You can see if you have a directory by:

  match stats.st_kind with
    S_DIR -> ...
  | _ -> ...
  

val recurse_list : string -> (string * Unix.stats) list

Same as Unixutil.recurse_stream, but generates a list instead. Not recommended since this list could be *huge*.

val recurse_cmd : (string * Unix.stats -> unit) -> string -> unit

recurse_cmd func name

will call

func stats name

on every entry in or beneath name, which may specify a directory or a file. For entries in subdirectires, the full relative path starting from name will be passed.

val rm : ?recursive:bool -> ?force:bool -> string -> unit

Remove files or directories.

By default, will remove only a given file and will raise an error if it fails to do so.

if ~force is given and is set true, errors are never raised but simply ignored.

If ~recursive is given and is set true, a directory name may be given. The directory and all entries beneath it will be removed.