package stdune

You can search for identifiers within the package.

in-package search v0.2.0

Dune's unstable standard library

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (17)

Authors

J

Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

J

Jane Street Group, LLC <opensource@janestreet.com>

Sources

dune-3.4.0.tbz

sha256=0a5566c4910f193d609965a034b482085dc04e0bcdfec9756ff9957df2b67a3c

sha512=74cd3aa75fb0fcc098b6dcf69d6d904221b69b52430e910e0839e1706c453647a4d107471b55363e16ba8094e62461736a1e52eca08dd288cbb15d3d6ce0df10

doc/stdune/Stdune/Fpath/index.html

Module `Stdune.Fpath`Source

Functions on paths that are represented as strings

Sourcetype mkdir_result =

| Already_exists
(*
The directory already exists. No action was taken.
*)
| Created
(*
The directory was created.
*)
| 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 =

| Already_exists
(*
The directory already exists. No action was taken.
*)
| Created
(*
The directory was created.
*)

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

Sourcetype follow_symlink_error =

| Not_a_symlink
| Max_depth_exceeded
| Unix_error of Dune_filesystem_stubs.Unix_error.Detailed.t

Sourceval follow_symlink : string -> (string, follow_symlink_error) result

Sourceval follow_symlinks : string -> string option

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).

Sourceval unlink : string -> unit

Sourceval unlink_no_err : string -> unit

Sourceval initial_cwd : string

Sourcetype clear_dir_result =

| Cleared
| 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