package stdune

You can search for identifiers within the package.

in-package search v0.2.0

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

Error meant for humans

exception E of User_message.t

User errors are errors that users need to fix themselves in order to make progress. Since these errors are read by users, they should be simple to understand for people who are not familiar with the dune codebase.

val raise : 
  ?loc:Stdune__.Loc0.t ->
  ?hints:User_message.Style.t Pp.t list ->
  ?annots:User_message.Annots.t ->
  User_message.Style.t Pp.t list ->
  _

Raise a user error. The arguments are interpreted in the same way as User_message.make. The first paragraph is prefixed with "Error:".

val make : 
  ?loc:Stdune__.Loc0.t ->
  ?hints:User_message.Style.t Pp.t list ->
  ?annots:User_message.Annots.t ->
  User_message.Style.t Pp.t list ->
  User_message.t

Create a user error.

val prefix : User_message.Style.t Pp.t

The "Error:" prefix