package lsp

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Error meant for humans

module Annot : sig ... end
exception E of User_message.t * Annot.t list

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.

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

val raise : ?loc:Stdune__.Loc0.t -> ?hints:User_message.Style.t Pp.t list -> ?annots:Annot.t list -> 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 -> 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

val has_location : User_message.t -> Annot.t list -> bool

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

val has_embed_location : Annot.t list -> bool

Returns true if the following list of annotations contains Annot.Has_embedded_location.

OCaml

Innovation. Community. Security.