Dir (p.mfat.0.0.1~beta1.doc.mfat.bos.Mfat

Sourceval exists : blk Mfat.t -> Fpath.t -> (bool, 'err) result

exists t dir is true if dir is a directory in the file system and false otherwise.

Sourceval must_exist : blk Mfat.t -> Fpath.t -> (Fpath.t, [> `Msg of string ]) result

must_exist t dir is Ok dir if dir is a directory in the file system and an error otherwise.

val create : 
  blk Mfat.t ->
  ?path:bool ->
  Fpath.t ->
  (bool, [> `Msg of string ]) result

create t ~path dir creates, if needed, the directory dir. If path is true (default) intermediate directories are created, otherwise missing intermediate directories lead to an error. The result is Ok true if dir did not exist and was created, Ok false if dir already existed as a directory.

Source

val delete : 
  blk Mfat.t ->
  ?must_exist:bool ->
  ?recurse:bool ->
  Fpath.t ->
  (unit, [> `Msg of string ]) result

delete t ~must_exist ~recurse dir deletes the directory dir. If must_exist is true (defaults to false) an error is returned if dir doesn't exist. If recurse is true (default to false) no error occurs if the directory is non-empty: its contents is recursively deleted first.

Source

val contents : 
  blk Mfat.t ->
  ?rel:bool ->
  Fpath.t ->
  (Fpath.t list, [> `Msg of string ]) result

contents t ~rel dir is the list of directories and files in dir. If rel is true (defaults to false) the resulting paths are relative to dir, otherwise they have dir prepended.

Source

val fold_contents : 
  ?err:'b error ->
  ?dotfiles:bool ->
  ?elements:elements ->
  ?traverse:traverse ->
  blk Mfat.t ->
  (Fpath.t -> 'a -> 'a) ->
  'a ->
  Fpath.t ->
  ('a, [ `Msg of string ]) result

fold_contents err dotfiles elements traverse t f acc d is: contents t d >>= fold err dotfiles elements traverse t f acc.