Module CCMonadIO.File

module File: sig .. end

type t = string

A file is always represented by its absolute path

val to_string : t -> string

val make : string -> t

Build a file representation from a path (absolute or relative)

val exists : t -> bool CCMonadIO.io

val is_directory : t -> bool CCMonadIO.io

val remove : t -> unit CCMonadIO.io

val read_dir : ?recurse:bool ->
       t -> t CCMonadIO.Seq.t CCMonadIO.io

read_dir d returns a sequence of files and directory contained in the directory d (or an empty stream if d is not a directory)

recurse : if true (default false), sub-directories are also explored

val walk : t ->
       ([ `Dir | `File ] * t) CCMonadIO.Seq.t CCMonadIO.io

Similar to CCMonadIO.File.read_dir (with recurse=true), this function walks a directory recursively and yields either files or directories. Is a file anything that doesn't satisfy CCMonadIO.File.is_directory (including symlinks, etc.)