package stdune

You can search for identifiers within the package.

in-package search v0.2.0

package stdune

stdune
- Stdune
  - Ansi_color
    
    RGB24
    
    RGB8
    
    Style
  - Appendable_list
  - Applicative
    
    Basic
    
    Id
    
    O
    
    Make
    
    A
    
    O
    
    O
  - Array
  - Bin
  - Bool
  - Bytes
  - Bytes_unit
  - Caller_id
  - Char
  - Code_error
  - Comparable
    
    Make
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparable_intf
    
    S
    
    Map
    
    Multi
    
    Set
  - Comparator
    
    OPS
    
    Operators
    
    X
    
    S
  - Dev_null
  - Either
  - Env
    
    Map
    
    Multi
    
    Set
    
    Var
    
    Map
    
    Multi
    
    Set
  - Env_path
  - Exn
  - Exn_with_backtrace
  - Fdecl
  - File_kind
  - Filename
    
    Extension
  - Float
  - Fpath
  - Hashtbl
    
    Make
    
    Key
    
    S
  - Id
    
    Make
    
    Map
    
    Multi
    
    Set
    
    Table
    
    S
    
    Map
    
    Multi
    
    Set
    
    Table
  - Int
    
    Infix
    
    Map
    
    Multi
    
    Set
  - Io
    
    String_path
  - Lexbuf
  - List
  - Loc
    
    Map
    
    Multi
  - Map
    
    Key
    
    Make
    
    Key
    
    Multi
    
    S
    
    Multi
  - Monad
    
    Basic
    
    Id
    
    O
    
    List
    
    M
    
    O
    
    Make
    
    M
    
    O
    
    O
    
    Option
    
    M
    
    O
    
    Result
    
    M
    
    O
    
    S
    
    O
  - Monoid
    
    Add
    
    M
    
    O
    
    Appendable_list
    
    M
    
    O
    
    Basic
    
    Commutative
    
    Add
    
    M
    
    O
    
    Basic
    
    Exists
    
    O
    
    Forall
    
    O
    
    Function
    
    A
    
    M
    
    O
    
    Make
    
    M
    
    O
    
    Mul
    
    M
    
    O
    
    Product
    
    A
    
    B
    
    O
    
    Product3
    
    A
    
    B
    
    C
    
    O
    
    S
    
    O
    
    Union
    
    M
    
    O
    
    Unit
    
    O
    
    Endofunction
    
    Left
    
    A
    
    O
    
    Right
    
    A
    
    O
    
    Exists
    
    O
    
    Forall
    
    O
    
    Function
    
    A
    
    M
    
    O
    
    List
    
    M
    
    O
    
    Make
    
    M
    
    O
    
    Mul
    
    M
    
    O
    
    O
    
    Product
    
    A
    
    B
    
    O
    
    Product3
    
    A
    
    B
    
    C
    
    O
    
    S
    
    O
    
    String
    
    O
    
    Union
    
    M
    
    O
    
    Unit
    
    O
  - Nonempty_list
  - Nothing
  - Option
    
    List
    
    O
  - Or_exn
    
    O
  - Path
    
    Build
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Expert
    
    External
    
    Map
    
    Multi
    
    Set
    
    Table
    
    L
    
    Local
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Local_gen
    
    Fix_root
    
    Map
    
    Multi
    
    Root
    
    Set
    
    Table
    
    L
    
    Map
    
    Multi
    
    Outside_build_dir
    
    Table
    
    Permissions
    
    Set
    
    Source
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Table
    
    Unspecified
  - Pid
  - Platform
    
    OS
  - Poly
  - Predicate
  - Proc
    
    Process_info
    
    Resource_usage
    
    Times
  - Queue
  - Result
    
    List
    
    O
    
    Option
  - Scanf
  - Seq
  - Set
    
    Make
    
    Key
    
    M
    
    Multi
    
    Of_map
    
    Key
    
    M
    
    Multi
    
    S
  - Sexp
  - Signal
  - Staged
  - State
    
    Make
    
    M
    
    O
    
    O
    
    S
  - String
    
    Caseless
    
    Map
    
    Multi
    
    Set
    
    Table
  - Sys
  - Table
    
    Key
    
    Multi
  - Temp
    
    Monad
    
    M
  - Top_closure
    
    Int
    
    Make
    
    Keys
    
    Monad
    
    O
    
    String
  - Top_closure_intf
    
    Keys
    
    S
  - Tuple
    
    T2
    
    T3
  - Type_eq
    
    Id
  - Unit
  - Univ_map
    
    Key
    
    Make
    
    Key
    
    S
    
    Key
  - Unix_error
    
    Detailed
  - User_error
  - User_message
    
    Annots
    
    Key
    
    Print_config
    
    Style
  - User_warning
stdune.filesystem_stubs
- Dune_filesystem_stubs
  - File_kind
  - Unix_error
    
    Detailed

Legend:
Library
Module
Module type
Parameter
Class
Class type

Functions on paths that are represented as strings

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

val mkdir : ?perms:int -> string -> mkdir_result

type mkdir_p_result =

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

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

type follow_symlink_error =

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

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

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

val unlink : string -> unit

val unlink_no_err : string -> unit

val initial_cwd : string

type clear_dir_result =

| Cleared
| Directory_does_not_exist

val clear_dir : string -> clear_dir_result

val rm_rf : string -> unit

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

val is_root : string -> bool