package coq-core

  1. Overview
  2. Docs
The Coq Proof Assistant -- Core Binaries and Tools

Install

Dune Dependency

Authors

Maintainers

Sources

coq-8.20.1.tar.gz
md5=0cfaa70f569be9494d24c829e6555d46
sha512=8ee967c636b67b22a4f34115871d8f9b9114df309afc9ddf5f61275251088c6e21f6cf745811df75554d30f4cebb6682f23eeb2e88b771330c4b60ce3f6bf5e2

doc/coq-core.clib/Exninfo/index.html

Module ExninfoSource

Additional information worn by exceptions.

Sourcetype 'a t

Information containing a given type.

Sourcetype info

All information

Sourcetype iexn = exn * info

Information-wearing exceptions

Sourceval make : string -> 'a t

Create a new piece of information.

Sourceval null : info

No information

Sourceval add : info -> 'a t -> 'a -> info

Add information to an exception.

Sourceval get : info -> 'a t -> 'a option

Get information worn by an exception. Returns None if undefined.

Sourceval info : exn -> info

Retrieve the information of the last exception raised.

Sourcetype backtrace
Sourceval get_backtrace : info -> backtrace option

get_backtrace info does get the backtrace associated to info

Sourceval backtrace_to_string : backtrace -> string

backtrace_to_string info does get the backtrace associated to info

Sourceval record_backtrace : bool -> unit
Sourceval capture : exn -> iexn

Add the current backtrace information and other meta-data to the given exception.

The intended use case is to re-raise an exception while preserving the meta-data:


try foo
with
| Bar -> bar
| My_exn _ as exn ->
  let (exn, info) = Exninfo.capture err in
  ...
  let info = ... in
  Exninfo.iraise (exn, info)

| exn when CErrors.noncritical exn ->
  let iexn = Exninfo.capture err in
  ...
  Exninfo.iraise iexn

where baz should re-raise using iraise below.

WARNING: any intermediate code between the with and the handler may modify the backtrace. Yes, that includes when clauses. Ideally, what you should do is something like:


try foo
with exn when CErrors.noncritical exn ->
  let (err, info) = Exninfo.capture exn in
  match err with
  | exception Bar -> ...
  | err -> ...

I admit that's a bit heavy, but there is not much to do...

Sourceval iraise : iexn -> 'a

Raise the given enriched exception.

Sourceval reify : unit -> info
OCaml

Innovation. Community. Security.