Debian Codegraph @

docs/apidoc/html/classXapian_1_1AssertionError.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.15.0"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Xapian: API Documentation: Xapian::AssertionError Class Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18 <tbody>
19 <tr style="height: 56px;">
20 <td id="projectalign" style="padding-left: 0.5em;">
21 <div id="projectname">xapian-core
22 &#160;<span id="projectnumber">1.4.31</span>
23 </div>
24 </td>
25 </tr>
26 </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.15.0 -->
31 <script type="text/javascript">
32 $(function() { codefold.init(); });
33 </script>
34 <script type="text/javascript" src="menudata.js"></script>
35 <script type="text/javascript" src="menu.js"></script>
36 <script type="text/javascript">
37 $(function() {
38 initMenu('',false,false,'search.php','Search',false);
39 });
40 </script>
41 <div id="main-nav"></div>
42 <div id="nav-path" class="navpath">
43 <ul>
44 <li class="navelem"><a href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a href="classXapian_1_1AssertionError.html">AssertionError</a></li> </ul>
45 </div>
46 </div><!-- top -->
47 <div id="doc-content">
48 <div class="header">
49 <div class="summary">
50 <a href="#pub-methods">Public Member Functions</a> &#124;
51 <a href="classXapian_1_1AssertionError-members.html">List of all members</a> </div>
52 <div class="headertitle"><div class="title">Xapian::AssertionError Class Reference</div></div>
53 </div><!--header-->
54 <div class="contents">
55
56 <p><a class="el" href="classXapian_1_1AssertionError.html" title="AssertionError is thrown if a logical assertion inside Xapian fails.">AssertionError</a> is thrown if a logical assertion inside <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> fails.
57 <a href="#details">More...</a></p>
58
59 <p><code>#include &lt;error.h&gt;</code></p>
60 <div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for Xapian::AssertionError:</div>
61 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
62 </div>
63 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
64 <div class="center"><img src="classXapian_1_1AssertionError__inherit__graph.png" border="0" usemap="#aXapian_1_1AssertionError_inherit__map" loading="lazy" alt="Inheritance graph"/></div>
65 <map name="aXapian_1_1AssertionError_inherit__map" id="aXapian_1_1AssertionError_inherit__map">
66 <area shape="rect" title="AssertionError is thrown if a logical assertion inside Xapian fails." alt="" coords="5,157,172,184"/>
67 <area shape="rect" href="classXapian_1_1LogicError.html" title="The base class for exceptions indicating errors in the program logic." alt="" coords="19,81,158,109"/>
68 <area shape="poly" title=" " alt="" coords="90,123,91,157,86,155,87,126"/>
69 <area shape="rect" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error." alt="" coords="36,5,141,33"/>
70 <area shape="poly" title=" " alt="" coords="90,46,91,81,86,80,87,51"/>
71 </map>
72 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
73 <table class="memberdecls">
74 <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
75 Public Member Functions</h2></td></tr>
76 <tr class="memitem:af34627d97cb4ec40b9916e39f4cc7922" id="r_af34627d97cb4ec40b9916e39f4cc7922"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af34627d97cb4ec40b9916e39f4cc7922">AssertionError</a> (const std::string &amp;msg_, const std::string &amp;context_=std::string(), int errno_=0)</td></tr>
77 <tr class="memdesc:af34627d97cb4ec40b9916e39f4cc7922"><td class="mdescLeft">&#160;</td><td class="mdescRight">General purpose constructor. <br /></td></tr>
78 <tr class="memitem:ae2f6e4b71b4aaeb52529c89339a9f0d7" id="r_ae2f6e4b71b4aaeb52529c89339a9f0d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2f6e4b71b4aaeb52529c89339a9f0d7">AssertionError</a> (const std::string &amp;msg_, int errno_)</td></tr>
79 <tr class="memdesc:ae2f6e4b71b4aaeb52529c89339a9f0d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from message and errno value. <br /></td></tr>
80 <tr class="inherit_header pub_methods_classXapian_1_1Error"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classXapian_1_1Error')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classXapian_1_1Error.html">Xapian::Error</a></td></tr>
81 <tr class="memitem:ae2663feca0ff541dcef3a79396dd05ab inherit pub_methods_classXapian_1_1Error" id="r_ae2663feca0ff541dcef3a79396dd05ab"><td class="memItemLeft" align="right" valign="top">
82 const char *&#160;</td><td class="memItemRight" valign="bottom"><b>get_type</b> () const</td></tr>
83 <tr class="memdesc:ae2663feca0ff541dcef3a79396dd05ab inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of this error (e.g. "DocNotFoundError".). <br /></td></tr>
84 <tr class="memitem:a840d36cfe92531bcbb7ad8baa445858a inherit pub_methods_classXapian_1_1Error" id="r_a840d36cfe92531bcbb7ad8baa445858a"><td class="memItemLeft" align="right" valign="top">
85 const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_msg</b> () const</td></tr>
86 <tr class="memdesc:a840d36cfe92531bcbb7ad8baa445858a inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Message giving details of the error, intended for human consumption. <br /></td></tr>
87 <tr class="memitem:a3e1cf96dd8dcff7008a4245a607122b7 inherit pub_methods_classXapian_1_1Error" id="r_a3e1cf96dd8dcff7008a4245a607122b7"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#a3e1cf96dd8dcff7008a4245a607122b7">get_context</a> () const</td></tr>
88 <tr class="memdesc:a3e1cf96dd8dcff7008a4245a607122b7 inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional context information. <br /></td></tr>
89 <tr class="memitem:ab0d5a2f12c551f5220716282b501a7a1 inherit pub_methods_classXapian_1_1Error" id="r_ab0d5a2f12c551f5220716282b501a7a1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html#ab0d5a2f12c551f5220716282b501a7a1">get_error_string</a> () const</td></tr>
90 <tr class="memdesc:ab0d5a2f12c551f5220716282b501a7a1 inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns any system error string associated with this exception. <br /></td></tr>
91 <tr class="memitem:a1fabaae0c1c2e5aa0164a5151c0b8c7f inherit pub_methods_classXapian_1_1Error" id="r_a1fabaae0c1c2e5aa0164a5151c0b8c7f"><td class="memItemLeft" align="right" valign="top">
92 std::string&#160;</td><td class="memItemRight" valign="bottom"><b>get_description</b> () const</td></tr>
93 <tr class="memdesc:a1fabaae0c1c2e5aa0164a5151c0b8c7f inherit pub_methods_classXapian_1_1Error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
94 </table>
95 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
96 <div class="textblock"><p><a class="el" href="classXapian_1_1AssertionError.html" title="AssertionError is thrown if a logical assertion inside Xapian fails.">AssertionError</a> is thrown if a logical assertion inside <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> fails. </p>
97 <p>In a debug build of <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a>, a failed assertion in the core library code will cause <a class="el" href="classXapian_1_1AssertionError.html" title="AssertionError is thrown if a logical assertion inside Xapian fails.">AssertionError</a> to be thrown.</p>
98 <p>This represents a bug in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> (either an invariant, precondition, etc has been violated, or the assertion is incorrect!) </p>
99 </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
100 <a id="af34627d97cb4ec40b9916e39f4cc7922" name="af34627d97cb4ec40b9916e39f4cc7922"></a>
101 <h2 class="memtitle"><span class="permalink"><a href="#af34627d97cb4ec40b9916e39f4cc7922">&#9670;&#160;</a></span>AssertionError() <span class="overload">[1/2]</span></h2>
102
103 <div class="memitem">
104 <div class="memproto">
105 <table class="mlabels">
106 <tr>
107 <td class="mlabels-left">
108 <table class="memname">
109 <tr>
110 <td class="memname">Xapian::AssertionError::AssertionError </td>
111 <td>(</td>
112 <td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>msg_</em></span>, </td>
113 </tr>
114 <tr>
115 <td class="paramkey"></td>
116 <td></td>
117 <td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>context_</em></span><span class="paramdefsep"> = </span><span class="paramdefval">std::string()</span>, </td>
118 </tr>
119 <tr>
120 <td class="paramkey"></td>
121 <td></td>
122 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>errno_</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
123 </tr>
124 </table>
125 </td>
126 <td class="mlabels-right">
127 <span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span></span> </td>
128 </tr>
129 </table>
130 </div><div class="memdoc">
131
132 <p>General purpose constructor. </p>
133 <dl class="params"><dt>Parameters</dt><dd>
134 <table class="params">
135 <tr><td class="paramname">msg_</td><td>Message giving details of the error, intended for human consumption. </td></tr>
136 <tr><td class="paramname">context_</td><td>Optional context information for this error. </td></tr>
137 <tr><td class="paramname">errno_</td><td>Optional errno value associated with this error. </td></tr>
138 </table>
139 </dd>
140 </dl>
141
142 </div>
143 </div>
144 <a id="ae2f6e4b71b4aaeb52529c89339a9f0d7" name="ae2f6e4b71b4aaeb52529c89339a9f0d7"></a>
145 <h2 class="memtitle"><span class="permalink"><a href="#ae2f6e4b71b4aaeb52529c89339a9f0d7">&#9670;&#160;</a></span>AssertionError() <span class="overload">[2/2]</span></h2>
146
147 <div class="memitem">
148 <div class="memproto">
149 <table class="mlabels">
150 <tr>
151 <td class="mlabels-left">
152 <table class="memname">
153 <tr>
154 <td class="memname">Xapian::AssertionError::AssertionError </td>
155 <td>(</td>
156 <td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>msg_</em></span>, </td>
157 </tr>
158 <tr>
159 <td class="paramkey"></td>
160 <td></td>
161 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>errno_</em></span>&#160;)</td>
162 </tr>
163 </table>
164 </td>
165 <td class="mlabels-right">
166 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
167 </tr>
168 </table>
169 </div><div class="memdoc">
170
171 <p>Construct from message and errno value. </p>
172 <dl class="params"><dt>Parameters</dt><dd>
173 <table class="params">
174 <tr><td class="paramname">msg_</td><td>Message giving details of the error, intended for human consumption. </td></tr>
175 <tr><td class="paramname">errno_</td><td>Optional errno value associated with this error. </td></tr>
176 </table>
177 </dd>
178 </dl>
179
180 </div>
181 </div>
182 <hr/>The documentation for this class was generated from the following file:<ul>
183 <li>xapian/<a class="el" href="error_8h.html">error.h</a></li>
184 </ul>
185 </div><!-- contents -->
186 <!-- start footer part -->
187 <hr class="footer"/><address class="footer"><small>
188 Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a>
189 </small></address>
190 </body>
191 </html>