package stdune

  1. Overview
  2. Docs
package stdune
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Stdune.FpathSource

Functions on paths that are represented as strings

Sourcetype mkdir_result =
  1. | Already_exists
    (*

    The directory already exists. No action was taken.

    *)
  2. | Created
    (*

    The directory was created.

    *)
  3. | Missing_parent_directory
    (*

    No parent directory, use mkdir_p if you want to create it too.

    *)
Sourceval mkdir : ?perms:int -> string -> mkdir_result
Sourcetype mkdir_p_result =
  1. | Already_exists
    (*

    The directory already exists. No action was taken.

    *)
  2. | Created
    (*

    The directory was created.

    *)
Sourceval mkdir_p : ?perms:int -> string -> mkdir_p_result

follow_symlinks path returns a file path that is equivalent to path, but free of symbolic links. The value None is returned if the maximum symbolic link depth is reached (i.e., follow_symlink returns the value Error Max_depth_exceeded on some intermediate path).

Unlink and return error, if any.

Sourceval initial_cwd : string
Sourcetype clear_dir_result =
  1. | Cleared
  2. | Directory_does_not_exist
Sourceval clear_dir : string -> clear_dir_result
Sourceval rm_rf : string -> unit

If the path does not exist, this function is a no-op.

Sourceval is_root : string -> bool
Sourceval traverse : dir:string -> init:'acc -> on_file:(dir:string -> Filename.t -> 'acc -> 'acc) -> on_dir:(dir:string -> Filename.t -> 'acc -> 'acc) -> 'acc
Sourceval traverse_files : dir:string -> init:'acc -> f:(dir:string -> Filename.t -> 'acc -> 'acc) -> 'acc
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct