PageRenderTime 54ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 0ms

/system/kievstore/depends/kyoto-do-not-need/doc/classes/KyotoCabinet/Error.html

https://bitbucket.org/pavelvasev/ride
HTML | 587 lines | 372 code | 212 blank | 3 comment | 0 complexity | 9f96e2aa60efae29fd18e6d1da1cb36e MD5 | raw file
Possible License(s): GPL-3.0, CC-BY-3.0 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    2. 

  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4. 

  4. <head>
    5. 

  5.   <title>Class: KyotoCabinet::Error [Kyoto Cabinet]</title>
    6. 

  6.   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7.   <meta http-equiv="Content-Script-Type" content="text/javascript" />
    8. 

  8.   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
    9. 

  9.   <script type="text/javascript">
    10. 

  10.   // <![CDATA[
    11. 

  11. 

  12.   function popupCode( url ) {
    13. 

  13.     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
    14. 

  14.   }
    15. 

  15. 

  16.   function toggleCode( id ) {
    17. 

  17.     if ( document.getElementById )
    18. 

  18.       elem = document.getElementById( id );
    19. 

  19.     else if ( document.all )
    20. 

  20.       elem = eval( "document.all." + id );
    21. 

  21.     else
    22. 

  22.       return false;
    23. 

  23. 

  24.     elemStyle = elem.style;
    25. 

  25. 

  26.     if ( elemStyle.display != "block" ) {
    27. 

  27.       elemStyle.display = "block"
    28. 

  28.     } else {
    29. 

  29.       elemStyle.display = "none"
    30. 

  30.     }
    31. 

  31. 

  32.     return true;
    33. 

  33.   }
    34. 

  34. 

  35.   // Make codeblocks hidden by default
    36. 

  36.   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
    37. 

  37. 

  38.   // ]]>
    39. 

  39.   </script>
    40. 

  40. 

  41. </head>
    42. 

  42. <body>
    43. 

  43. 

  44. 

  45.     <div id="classHeader">
    46. 

  46.         <table class="header-table">
    47. 

  47.         <tr class="top-aligned-row">
    48. 

  48.           <td><strong>Class</strong></td>
    49. 

  49.           <td class="class-name-in-header">KyotoCabinet::Error</td>
    50. 

  50.         </tr>
    51. 

  51.         <tr class="top-aligned-row">
    52. 

  52.             <td><strong>In:</strong></td>
    53. 

  53.             <td>
    54. 

  54. 

  55. 

  56.                 <a href="../../files/kyotocabinet_rb.html">
    57. 

  57. 

  58.                 kyotocabinet.rb
    59. 

  59. 

  60.                 </a>
    61. 

  61. 

  62. 

  63.         <br />
    64. 

  64. 

  65.             </td>
    66. 

  66.         </tr>
    67. 

  67. 

  68. 

  69.         <tr class="top-aligned-row">
    70. 

  70.             <td><strong>Parent:</strong></td>
    71. 

  71.             <td>
    72. 

  72. 

  73.                 RuntimeError
    74. 

  74. 

  75.             </td>
    76. 

  76.         </tr>
    77. 

  77. 

  78.         </table>
    79. 

  79.     </div>
    80. 

  80.   <!-- banner header -->
    81. 

  81. 

  82.   <div id="bodyContent">
    83. 

  83. 

  84.   <div id="contextContent">
    85. 

  85. 

  86.     <div id="description">
    87. 

  87.       <p>
    88. 

  88. <a href="Error.html">Error</a> data.
    89. 

  89. </p>
    90. 

  90. 

  91.     </div>
    92. 

  92. 

  93.    </div>
    94. 

  94. 

  95. 

  96.     <div id="method-list">
    97. 

  97.       <h3 class="section-bar">Methods</h3>
    98. 

  98. 

  99.       <div class="name-list">
    100. 

  100. 

  101.         <a href="#M000015">!=</a>&nbsp;&nbsp;
    102. 

  102. 

  103.         <a href="#M000014">==</a>&nbsp;&nbsp;
    104. 

  104. 

  105.         <a href="#M000009">code</a>&nbsp;&nbsp;
    106. 

  106. 

  107.         <a href="#M000013">inspect</a>&nbsp;&nbsp;
    108. 

  108. 

  109.         <a href="#M000011">message</a>&nbsp;&nbsp;
    110. 

  110. 

  111.         <a href="#M000010">name</a>&nbsp;&nbsp;
    112. 

  112. 

  113.         <a href="#M000007">new</a>&nbsp;&nbsp;
    114. 

  114. 

  115.         <a href="#M000008">set</a>&nbsp;&nbsp;
    116. 

  116. 

  117.         <a href="#M000012">to_s</a>&nbsp;&nbsp;
    118. 

  118. 

  119.       </div>
    120. 

  120.     </div>
    121. 

  121. 

  122.   </div>
    123. 

  123. 

  124.     <!-- if includes -->
    125. 

  125. 

  126.     <div id="section">
    127. 

  127. 

  128.     <div id="constants-list">
    129. 

  129.       <h3 class="section-bar">Constants</h3>
    130. 

  130. 

  131.       <div class="name-list">
    132. 

  132.         <table summary="Constants">
    133. 

  133. 

  134.         <tr class="top-aligned-row context-row">
    135. 

  135.           <td class="context-item-name">SUCCESS</td>
    136. 

  136.           <td>=</td>
    137. 

  137.           <td class="context-item-value">0</td>
    138. 

  138. 

  139.           <td>&nbsp;</td>
    140. 

  140.           <td class="context-item-desc">
    141. 

  141. error code: success
    142. 

  142. 

  143. </td>
    144. 

  144. 

  145.         </tr>
    146. 

  146. 

  147.         <tr class="top-aligned-row context-row">
    148. 

  148.           <td class="context-item-name">NOIMPL</td>
    149. 

  149.           <td>=</td>
    150. 

  150.           <td class="context-item-value">1</td>
    151. 

  151. 

  152.           <td>&nbsp;</td>
    153. 

  153.           <td class="context-item-desc">
    154. 

  154. error code: not implemented
    155. 

  155. 

  156. </td>
    157. 

  157. 

  158.         </tr>
    159. 

  159. 

  160.         <tr class="top-aligned-row context-row">
    161. 

  161.           <td class="context-item-name">INVALID</td>
    162. 

  162.           <td>=</td>
    163. 

  163.           <td class="context-item-value">2</td>
    164. 

  164. 

  165.           <td>&nbsp;</td>
    166. 

  166.           <td class="context-item-desc">
    167. 

  167. error code: invalid operation
    168. 

  168. 

  169. </td>
    170. 

  170. 

  171.         </tr>
    172. 

  172. 

  173.         <tr class="top-aligned-row context-row">
    174. 

  174.           <td class="context-item-name">NOFILE</td>
    175. 

  175.           <td>=</td>
    176. 

  176.           <td class="context-item-value">3</td>
    177. 

  177. 

  178.           <td>&nbsp;</td>
    179. 

  179.           <td class="context-item-desc">
    180. 

  180. error code: file not found
    181. 

  181. 

  182. </td>
    183. 

  183. 

  184.         </tr>
    185. 

  185. 

  186.         <tr class="top-aligned-row context-row">
    187. 

  187.           <td class="context-item-name">NOPERM</td>
    188. 

  188.           <td>=</td>
    189. 

  189.           <td class="context-item-value">4</td>
    190. 

  190. 

  191.           <td>&nbsp;</td>
    192. 

  192.           <td class="context-item-desc">
    193. 

  193. error code: no permission
    194. 

  194. 

  195. </td>
    196. 

  196. 

  197.         </tr>
    198. 

  198. 

  199.         <tr class="top-aligned-row context-row">
    200. 

  200.           <td class="context-item-name">BROKEN</td>
    201. 

  201.           <td>=</td>
    202. 

  202.           <td class="context-item-value">5</td>
    203. 

  203. 

  204.           <td>&nbsp;</td>
    205. 

  205.           <td class="context-item-desc">
    206. 

  206. error code: broken file
    207. 

  207. 

  208. </td>
    209. 

  209. 

  210.         </tr>
    211. 

  211. 

  212.         <tr class="top-aligned-row context-row">
    213. 

  213.           <td class="context-item-name">DUPREC</td>
    214. 

  214.           <td>=</td>
    215. 

  215.           <td class="context-item-value">6</td>
    216. 

  216. 

  217.           <td>&nbsp;</td>
    218. 

  218.           <td class="context-item-desc">
    219. 

  219. error code: record duplication
    220. 

  220. 

  221. </td>
    222. 

  222. 

  223.         </tr>
    224. 

  224. 

  225.         <tr class="top-aligned-row context-row">
    226. 

  226.           <td class="context-item-name">NOREC</td>
    227. 

  227.           <td>=</td>
    228. 

  228.           <td class="context-item-value">7</td>
    229. 

  229. 

  230.           <td>&nbsp;</td>
    231. 

  231.           <td class="context-item-desc">
    232. 

  232. error code: no record
    233. 

  233. 

  234. </td>
    235. 

  235. 

  236.         </tr>
    237. 

  237. 

  238.         <tr class="top-aligned-row context-row">
    239. 

  239.           <td class="context-item-name">LOGIC</td>
    240. 

  240.           <td>=</td>
    241. 

  241.           <td class="context-item-value">8</td>
    242. 

  242. 

  243.           <td>&nbsp;</td>
    244. 

  244.           <td class="context-item-desc">
    245. 

  245. error code: logical inconsistency
    246. 

  246. 

  247. </td>
    248. 

  248. 

  249.         </tr>
    250. 

  250. 

  251.         <tr class="top-aligned-row context-row">
    252. 

  252.           <td class="context-item-name">SYSTEM</td>
    253. 

  253.           <td>=</td>
    254. 

  254.           <td class="context-item-value">9</td>
    255. 

  255. 

  256.           <td>&nbsp;</td>
    257. 

  257.           <td class="context-item-desc">
    258. 

  258. error code: system error
    259. 

  259. 

  260. </td>
    261. 

  261. 

  262.         </tr>
    263. 

  263. 

  264.         <tr class="top-aligned-row context-row">
    265. 

  265.           <td class="context-item-name">MISC</td>
    266. 

  266.           <td>=</td>
    267. 

  267.           <td class="context-item-value">15</td>
    268. 

  268. 

  269.           <td>&nbsp;</td>
    270. 

  270.           <td class="context-item-desc">
    271. 

  271. error code: miscellaneous error
    272. 

  272. 

  273. </td>
    274. 

  274. 

  275.         </tr>
    276. 

  276. 

  277.         </table>
    278. 

  278.       </div>
    279. 

  279.     </div>
    280. 

  280. 

  281. 

  282. 

  283. 

  284.     <!-- if method_list -->
    285. 

  285. 

  286.     <div id="methods">
    287. 

  287. 

  288.       <h3 class="section-bar">Public Class methods</h3>
    289. 

  289. 

  290. 

  291.       <div id="method-M000007" class="method-detail">
    292. 

  292.         <a name="M000007"></a>
    293. 

  293. 

  294.         <div class="method-heading">
    295. 

  295. 

  296.           <a href="Error.src/M000007.html" target="Code" class="method-signature"
    297. 

  297.             onclick="popupCode('Error.src/M000007.html');return false;">
    298. 

  298. 

  299.           <span class="method-name">new</span><span class="method-args">(code, message)</span>
    300. 

  300. 

  301.           </a>
    302. 

  302. 

  303.         </div>
    304. 

  304. 

  305.         <div class="method-description">
    306. 

  306. 

  307.           <p>
    308. 

  308. Create an error object.
    309. 

  309. </p>
    310. 

  310. <ul>
    311. 

  311. <li><strong>@param <var>code</var></strong> the error code.
    312. 

  312. 

  313. </li>
    314. 

  314. <li><strong>@param <var>message</var></strong> the supplement message.
    315. 

  315. 

  316. </li>
    317. 

  317. <li><strong>@return</strong> the error object.
    318. 

  318. 

  319. </li>
    320. 

  320. </ul>
    321. 

  321. 

  322.         </div>
    323. 

  323.       </div>
    324. 

  324. 

  325. 

  326.       <h3 class="section-bar">Public Instance methods</h3>
    327. 

  327. 

  328. 

  329.       <div id="method-M000015" class="method-detail">
    330. 

  330.         <a name="M000015"></a>
    331. 

  331. 

  332.         <div class="method-heading">
    333. 

  333. 

  334.           <a href="Error.src/M000015.html" target="Code" class="method-signature"
    335. 

  335.             onclick="popupCode('Error.src/M000015.html');return false;">
    336. 

  336. 

  337.           <span class="method-name">!=</span><span class="method-args">(right)</span>
    338. 

  338. 

  339.           </a>
    340. 

  340. 

  341.         </div>
    342. 

  342. 

  343.         <div class="method-description">
    344. 

  344. 

  345.           <p>
    346. 

  346. Negation equality operator.
    347. 

  347. </p>
    348. 

  348. <ul>
    349. 

  349. <li><strong>@param <var>right</var></strong> an error object or an error code.
    350. 

  350. 

  351. </li>
    352. 

  352. <li><strong>@return</strong> false for the both operands are equal, or true if
    353. 

  353. not.
    354. 

  354. 

  355. </li>
    356. 

  356. </ul>
    357. 

  357. 

  358.         </div>
    359. 

  359.       </div>
    360. 

  360. 

  361. 

  362.       <div id="method-M000014" class="method-detail">
    363. 

  363.         <a name="M000014"></a>
    364. 

  364. 

  365.         <div class="method-heading">
    366. 

  366. 

  367.           <a href="Error.src/M000014.html" target="Code" class="method-signature"
    368. 

  368.             onclick="popupCode('Error.src/M000014.html');return false;">
    369. 

  369. 

  370.           <span class="method-name">==</span><span class="method-args">(right)</span>
    371. 

  371. 

  372.           </a>
    373. 

  373. 

  374.         </div>
    375. 

  375. 

  376.         <div class="method-description">
    377. 

  377. 

  378.           <p>
    379. 

  379. Equality operator.
    380. 

  380. </p>
    381. 

  381. <ul>
    382. 

  382. <li><strong>@param <var>right</var></strong> an error object or an error code.
    383. 

  383. 

  384. </li>
    385. 

  385. <li><strong>@return</strong> true for the both operands are equal, or false if
    386. 

  386. not.
    387. 

  387. 

  388. </li>
    389. 

  389. </ul>
    390. 

  390. 

  391.         </div>
    392. 

  392.       </div>
    393. 

  393. 

  394. 

  395.       <div id="method-M000009" class="method-detail">
    396. 

  396.         <a name="M000009"></a>
    397. 

  397. 

  398.         <div class="method-heading">
    399. 

  399. 

  400.           <a href="Error.src/M000009.html" target="Code" class="method-signature"
    401. 

  401.             onclick="popupCode('Error.src/M000009.html');return false;">
    402. 

  402. 

  403.           <span class="method-name">code</span><span class="method-args">()</span>
    404. 

  404. 

  405.           </a>
    406. 

  406. 

  407.         </div>
    408. 

  408. 

  409.         <div class="method-description">
    410. 

  410. 

  411.           <p>
    412. 

  412. Get the error code.
    413. 

  413. </p>
    414. 

  414. <ul>
    415. 

  415. <li><strong>@return</strong> the error code.
    416. 

  416. 

  417. </li>
    418. 

  418. </ul>
    419. 

  419. 

  420.         </div>
    421. 

  421.       </div>
    422. 

  422. 

  423. 

  424.       <div id="method-M000013" class="method-detail">
    425. 

  425.         <a name="M000013"></a>
    426. 

  426. 

  427.         <div class="method-heading">
    428. 

  428. 

  429.           <a href="Error.src/M000013.html" target="Code" class="method-signature"
    430. 

  430.             onclick="popupCode('Error.src/M000013.html');return false;">
    431. 

  431. 

  432.           <span class="method-name">inspect</span><span class="method-args">()</span>
    433. 

  433. 

  434.           </a>
    435. 

  435. 

  436.         </div>
    437. 

  437. 

  438.         <div class="method-description">
    439. 

  439. 

  440.           <p>
    441. 

  441. Get the inspection string.
    442. 

  442. </p>
    443. 

  443. <ul>
    444. 

  444. <li><strong>@return</strong> the inspection string.
    445. 

  445. 

  446. </li>
    447. 

  447. </ul>
    448. 

  448. 

  449.         </div>
    450. 

  450.       </div>
    451. 

  451. 

  452. 

  453.       <div id="method-M000011" class="method-detail">
    454. 

  454.         <a name="M000011"></a>
    455. 

  455. 

  456.         <div class="method-heading">
    457. 

  457. 

  458.           <a href="Error.src/M000011.html" target="Code" class="method-signature"
    459. 

  459.             onclick="popupCode('Error.src/M000011.html');return false;">
    460. 

  460. 

  461.           <span class="method-name">message</span><span class="method-args">()</span>
    462. 

  462. 

  463.           </a>
    464. 

  464. 

  465.         </div>
    466. 

  466. 

  467.         <div class="method-description">
    468. 

  468. 

  469.           <p>
    470. 

  470. Get the supplement message.
    471. 

  471. </p>
    472. 

  472. <ul>
    473. 

  473. <li><strong>@return</strong> the supplement message.
    474. 

  474. 

  475. </li>
    476. 

  476. </ul>
    477. 

  477. 

  478.         </div>
    479. 

  479.       </div>
    480. 

  480. 

  481. 

  482.       <div id="method-M000010" class="method-detail">
    483. 

  483.         <a name="M000010"></a>
    484. 

  484. 

  485.         <div class="method-heading">
    486. 

  486. 

  487.           <a href="Error.src/M000010.html" target="Code" class="method-signature"
    488. 

  488.             onclick="popupCode('Error.src/M000010.html');return false;">
    489. 

  489. 

  490.           <span class="method-name">name</span><span class="method-args">()</span>
    491. 

  491. 

  492.           </a>
    493. 

  493. 

  494.         </div>
    495. 

  495. 

  496.         <div class="method-description">
    497. 

  497. 

  498.           <p>
    499. 

  499. Get the readable string of the code.
    500. 

  500. </p>
    501. 

  501. <ul>
    502. 

  502. <li><strong>@return</strong> the readable string of the code.
    503. 

  503. 

  504. </li>
    505. 

  505. </ul>
    506. 

  506. 

  507.         </div>
    508. 

  508.       </div>
    509. 

  509. 

  510. 

  511.       <div id="method-M000008" class="method-detail">
    512. 

  512.         <a name="M000008"></a>
    513. 

  513. 

  514.         <div class="method-heading">
    515. 

  515. 

  516.           <a href="Error.src/M000008.html" target="Code" class="method-signature"
    517. 

  517.             onclick="popupCode('Error.src/M000008.html');return false;">
    518. 

  518. 

  519.           <span class="method-name">set</span><span class="method-args">(code, message)</span>
    520. 

  520. 

  521.           </a>
    522. 

  522. 

  523.         </div>
    524. 

  524. 

  525.         <div class="method-description">
    526. 

  526. 

  527.           <p>
    528. 

  528. Set the error information.
    529. 

  529. </p>
    530. 

  530. <ul>
    531. 

  531. <li><strong>@param <var>code</var></strong> the error code.
    532. 

  532. 

  533. </li>
    534. 

  534. <li><strong>@param <var>message</var></strong> the supplement message.
    535. 

  535. 

  536. </li>
    537. 

  537. <li><strong>@return</strong> always nil.
    538. 

  538. 

  539. </li>
    540. 

  540. </ul>
    541. 

  541. 

  542.         </div>
    543. 

  543.       </div>
    544. 

  544. 

  545. 

  546.       <div id="method-M000012" class="method-detail">
    547. 

  547.         <a name="M000012"></a>
    548. 

  548. 

  549.         <div class="method-heading">
    550. 

  550. 

  551.           <a href="Error.src/M000012.html" target="Code" class="method-signature"
    552. 

  552.             onclick="popupCode('Error.src/M000012.html');return false;">
    553. 

  553. 

  554.           <span class="method-name">to_s</span><span class="method-args">()</span>
    555. 

  555. 

  556.           </a>
    557. 

  557. 

  558.         </div>
    559. 

  559. 

  560.         <div class="method-description">
    561. 

  561. 

  562.           <p>
    563. 

  563. Get the string expression.
    564. 

  564. </p>
    565. 

  565. <ul>
    566. 

  566. <li><strong>@return</strong> the string expression.
    567. 

  567. 

  568. </li>
    569. 

  569. </ul>
    570. 

  570. 

  571.         </div>
    572. 

  572.       </div>
    573. 

  573. 

  574. 

  575. 

  576.     </div>
    577. 

  577. 

  578. 

  579. 

  580. 

  581.   </div>
    582. 

  582. 

  583. <div id="validator-badges">
    584. 

  584. </div>
    585. 

  585. 

  586. </body>
    587. 

  587. </html>
    588. 

  588.