Error meant for humans
module Annot : sig ... endexception E of User_message.t * Annot.t listUser 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.tCreate a user error.
val prefix : User_message.Style.t Pp.tThe "Error:" prefix
val has_location : User_message.t -> Annot.t list -> boolReturns true if the message has an explicit location or one embed in the text.
val has_embed_location : Annot.t list -> boolReturns true if the following list of annotations contains Annot.Has_embedded_location.