summaryrefslogtreecommitdiff
path: root/docs/api/cpp/exceptions.rst
blob: 5fa65e5e52dade397176c9698ed9c9c066cd4858 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Exceptions
==========

The cvc5 API communicates certain errors using exceptions. We broadly
distinguish two types of exceptions: :cpp:class:`CVC5ApiException
<cvc5::api::CVC5ApiException>` and :cpp:class:`CVC5ApiRecoverableException
<cvc5::api::CVC5ApiRecoverableException>` (which is derived from
:cpp:class:`CVC5ApiException <cvc5::api::CVC5ApiException>`).

If any method fails with a :cpp:class:`CVC5ApiRecoverableException
<cvc5::api::CVC5ApiRecoverableException>`, the solver behaves as if the failing
method was not called. The solver can still be used safely.

If, however, a method fails with a :cpp:class:`CVC5ApiException
<cvc5::api::CVC5ApiException>`, the associated object may be in an unsafe state
and it should no longer be used.


.. doxygenclass:: cvc5::api::CVC5ApiException
    :project: cvc5
    :members:
    :undoc-members:

.. doxygenclass:: cvc5::api::CVC5ApiRecoverableException
    :project: cvc5
    :members:
    :undoc-members:
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback