Previous  Up  Next

Module type Parameter_sig.Specific_dir

module type Specific_dir = sig .. end

signature for searching files in a specific directory.

val set : Filepath.Normalized.t -> unit

Sets the plugin <specific-dir> directory (without creating it).

val get : unit -> Filepath.Normalized.t
val is_set : unit -> bool
val get_dir : ?mode:[ `Create_path | `Must_exist | `Normalize_only ] ->
       string -> Filepath.Normalized.t

get_dir ?mode p returns a (local) path p, i.e. relative to the plugin <specific-dir> directory, of a sub-directory of the plugin <specific-dir> directory.

mode : determines how to handle the resulting path:
  1. Normalize_only just normalizes the resulting path (default).
  2. Create_path creates the resulting path, if does not exist.
  3. Must_exist aborts if the resulting path does not exist.
val get_file : ?mode:[ `Create_path | `Must_exist | `Normalize_only ] ->
       string -> Filepath.Normalized.t

get_file ?mode p returns a (local) path p, i.e. relative to the plugin <specific-dir> directory, of a file in the plugin <specific-dir> directory.

mode : determines how to handle the resulting path:
  1. Normalize_only just normalizes the resulting path (default).
  2. Create_path creates the dirname of resulting path, if does not exist.
  3. Must_exist aborts if the resulting path does not exist.