package lsp

You can search for identifiers within the package.

in-package search v0.2.0

lsp
- Lsp
lsp.dyn
- Dyn
lsp.filesystem_stubs
- Dune_filesystem_stubs
  - File_kind
  - Unix_error
    
    Detailed
lsp.ordering
- Ordering
  - O
lsp.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
  - Fcntl
  - 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
  - Lock_file
  - 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

Legend:
Library
Module
Module type
Parameter
Class
Class type

A message for the user

User messages are styled document that can be printed to the console or in the log file.

module Style : sig ... end

Symbolic styles that can be used inside messages. These styles are later converted to actual concrete styles depending on the output device. For instance, when printed to the terminal they are converted to ansi terminal styles (Ansi_color.Style.t list values).

module Annots : sig ... end

type t = {

loc : Stdune__.Loc0.t option;
paragraphs : Style.t Pp.t list;
hints : Style.t Pp.t list;
annots : Annots.t;

}

A user message.contents composed of an optional file location and a list of paragraphs.

The various paragraphs will be printed one after the other and will all start at the beginning of a line. They are all wrapped inside a Pp.box.

When hints are provided, they are printed as last paragraphs and prefixed with "Hint:". Hints should give indication to the user for how to fix the issue.

The annots field is intended to carry extra context for other, non-user-facing purposes (such as data for the RPC).

val pp : t -> Style.t Pp.t

module Print_config : sig ... end

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

Construct a user message from a list of paragraphs.

The first paragraph is prefixed with prefix inside the box. prefix should not end with a space as a space is automatically inserted by make if necessary.

val print : ?config:Print_config.t -> t -> unit

Print to stdout (not thread safe)

val prerr : ?config:Print_config.t -> t -> unit

Print to stderr (not thread safe)

val did_you_mean : string -> candidates:string list -> Style.t Pp.t list

Produces a "Did you mean ...?" hint

val to_string : t -> string

Produces a plain text representation of the error message, without the "Error: " prefix.

val has_location : t -> bool

Returns true if the message has an explicit location or one embedded in the text.

val has_embedded_location : t -> bool

Returns true if the message's annotations contains Annot.Has_embedded_location.

val needs_stack_trace : t -> bool

Returns true if the message's annotations contains Annot.Needs_stack_trace.