Module Odoc_xref2.Lookup_failures

type kind = [
| `Root
| `Internal
| `Warning
]

`Root failures won't be turned into fatal warnings. `Internal is for lookup failures other than root modules and `Warning for messages to the users. They may be turned into fatal warnings depending on ~warn_error.

type 'a with_failures

A value that may be partially unresolved due to failures.

val catch_failures : (unit -> 'a) -> 'a with_failures
val report : ?⁠kind:kind -> ('fmt, Stdlib.Format.formatter, unit, unit) Stdlib.format4 -> 'fmt

Report a lookup failure to the enclosing catch_failures call.

val report_important : ?⁠kind:kind -> exn -> ('fmt, Stdlib.Format.formatter, unit, unit) Stdlib.format4 -> 'fmt

Like report above but may raise the exception exn if strict mode is enabled

val with_location : Odoc_model.Location_.span -> (unit -> 'a) -> 'a

Failures reported indirectly by this function will have a location attached.

val handle_failures : warn_error:bool -> filename:string -> 'a with_failures -> ('a, [> `Msg of string ]) Result.result

Print failures to stderr. Some failures may be turned into warnings, Error.handle_warnings will be called to print them.