package stdune

You can search for identifiers within the package.

in-package search v0.2.0

package stdune

stdune
- Stdune
  - Ansi_color
    
    Style
  - Appendable_list
  - Applicative
    
    Basic
    
    Id
    
    O
    
    Make
    
    A
    
    O
    
    O
  - Array
  - Bin
  - Bool
  - Bytes
  - Caller_id
  - Char
  - Code_error
  - Comparable
    
    Make
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparable_intf
    
    S
    
    Map
    
    Multi
    
    Set
  - Comparator
    
    OPS
    
    Operators
    
    X
    
    S
  - Console
    
    Backend
    
    S
    
    Status_line
  - Digest
    
    Direct_impl
    
    Map
    
    Multi
    
    Path_digest_result
    
    Set
    
    Stats_for_digest
  - Either
  - Env
    
    Map
    
    Multi
    
    Set
    
    Var
    
    Map
    
    Multi
    
    Set
  - Exn
  - Exn_with_backtrace
  - Fdecl
  - File_kind
  - Filename
  - 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
  - Metrics
    
    Timer
    
    Measure
  - Monad
    
    Basic
    
    Id
    
    O
    
    List
    
    M
    
    O
    
    Make
    
    M
    
    O
    
    O
    
    Option
    
    M
    
    O
    
    S
    
    O
  - Monoid
    
    Add
    
    M
    
    O
    
    Appendable_list
    
    M
    
    O
    
    Basic
    
    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
    
    Kind
    
    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
    
    Permissions
    
    Set
    
    Source
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Table
    
    Unspecified
  - Pid
  - Poly
  - 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
    
    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

Digests (MD5)

type t

include Comparable_intf.S with type key := t

module Map : sig ... end

module Set : sig ... end

val to_dyn : t -> Dyn.t

val hash : t -> int

val equal : t -> t -> bool

val compare : t -> t -> Ordering.t

val to_string : t -> string

val from_hex : string -> t option

val file : Path.t -> t

val string : string -> t

val to_string_raw : t -> string

val generic : 'a -> t

module Stats_for_digest : sig ... end

The subset of fields of Unix.stats used by this module.

module Path_digest_result : sig ... end

val path_with_stats : 
  allow_dirs:bool ->
  Path.t ->
  Stats_for_digest.t ->
  Path_digest_result.t

Digest a path taking into account its Stats_for_digest.

If it's a regular file, the resulting digest includes the file's content as well as the its executable permissions bit.

If it's a directory and allow_dirs = true, the function computes the digest of Stats_for_digest (except for the st_kind field since it's known to be S_DIR in this case). This is a poor approach to computing directory digests and we are planning to get rid of it soon.

Otherwise, the function returns Unexpected_kind.

Note that this interface is prone to races: the provided Stats_for_digest may get stale, so path_with_stats may return Unix_error (ENOENT, _, _) even though you've just successfully run Path.stat on it. The call sites are expected to gracefully handle such races.

val file_with_executable_bit : executable:bool -> Path.t -> t

Digest a file taking the executable bit into account. Should not be called on a directory.

val override_impl : file:(string -> t) -> string:(string -> t) -> unit

Override the implementations of digest computation. Can be used to record the reverse digest map.

module Direct_impl : sig ... end

Direct_impl does a plain hashing, with no heed to the overrides given by override_impl.