• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Function set_invariant_failure</title>
5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Contract 1.0.0">
8<link rel="up" href="../../reference.html#header.boost.contract.core.exception_hpp" title="Header &lt;boost/contract/core/exception.hpp&gt;">
9<link rel="prev" href="exit_invariant_failure.html" title="Function exit_invariant_failure">
10<link rel="next" href="specify_except.html" title="Class specify_except">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="exit_invariant_failure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.exception_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="specify_except.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.contract.set_invariant_failure"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function set_invariant_failure</span></h2>
29<p>boost::contract::set_invariant_failure — Set failure handler for class invariants (at both entry and exit). </p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../reference.html#header.boost.contract.core.exception_hpp" title="Header &lt;boost/contract/core/exception.hpp&gt;">boost/contract/core/exception.hpp</a>&gt;
33
34</span>
35<span class="identifier">from_failure_handler</span> <span class="keyword">const</span>  <span class="special">&amp;</span>
36<span class="identifier">set_invariant_failure</span><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre></div>
37<div class="refsect1">
38<a name="idm45988678416384"></a><h2>Description</h2>
39<p>This is provided for convenience and it is equivalent to call both  <code class="computeroutput"><code class="computeroutput"><a class="link" href="set_entr_idm46268585146336.html" title="Function set_entry_invariant_failure">boost::contract::set_entry_invariant_failure</a></code></code> and  <code class="computeroutput"><code class="computeroutput"><a class="link" href="set_exit_invariant_failure.html" title="Function set_exit_invariant_failure">boost::contract::set_exit_invariant_failure</a></code></code> with the same functor parameter <code class="computeroutput">f</code>.</p>
40<p><span class="bold"><strong>Throws:</strong></span> This is declared <code class="computeroutput">noexcept</code> (or <code class="computeroutput">throw()</code> before C++11).</p>
41<p>
42
43</p>
44<p><span class="bold"><strong>See Also:</strong></span></p>
45<p> <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)"> Throw on Failure</a>,  <a class="link" href="../../boost_contract/tutorial.html#boost_contract.tutorial.class_invariants" title="Class Invariants"> Class Invariants</a>,  <a class="link" href="../../boost_contract/extras.html#boost_contract.extras.volatile_public_functions" title="Volatile Public Functions">
46        Volatile Public Functions</a> </p>
47<p>
48</p>
49<p>
50</p>
51<div class="variablelist"><table border="0" class="variablelist compact">
52<colgroup>
53<col align="left" valign="top">
54<col>
55</colgroup>
56<tbody>
57<tr>
58<td><p><span class="term">Parameters:</span></p></td>
59<td><div class="variablelist"><table border="0" class="variablelist compact">
60<colgroup>
61<col align="left" valign="top">
62<col>
63</colgroup>
64<tbody><tr>
65<td><p><span class="term"><code class="computeroutput">f</code></span></p></td>
66<td><p>New failure handler functor to set for both entry and exit invariants.</p></td>
67</tr></tbody>
68</table></div></td>
69</tr>
70<tr>
71<td><p><span class="term">Returns:</span></p></td>
72<td><p>Same failure handler functor <code class="computeroutput">f</code> passed as parameter (e.g., for concatenating function calls).</p></td>
73</tr>
74</tbody>
75</table></div>
76</div>
77</div>
78<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
79<td align="left"></td>
80<td align="right"><div class="copyright-footer">Copyright © 2008-2019 Lorenzo Caminiti<p>
81        Distributed under the Boost Software License, Version 1.0 (see accompanying
82        file LICENSE_1_0.txt or a copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
83      </p>
84</div></td>
85</tr></table>
86<hr>
87<div class="spirit-nav">
88<a accesskey="p" href="exit_invariant_failure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.exception_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="specify_except.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
89</div>
90</body>
91</html>
92