You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

363 lines
11 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>errors - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package errors</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "github.com/syndtr/goleveldb/leveldb/errors"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. </dl>
  58. </div>
  59. <!-- The package's Name is printed as title by the top-level template -->
  60. <div id="pkg-overview" class="toggleVisible">
  61. <div class="collapsed">
  62. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  63. </div>
  64. <div class="expanded">
  65. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  66. <p>
  67. Package errors provides common error types used throughout leveldb.
  68. </p>
  69. </div>
  70. </div>
  71. <div id="pkg-index" class="toggleVisible">
  72. <div class="collapsed">
  73. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  74. </div>
  75. <div class="expanded">
  76. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  77. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  78. <div id="manual-nav">
  79. <dl>
  80. <dd><a href="index.html#pkg-variables">Variables</a></dd>
  81. <dd><a href="index.html#IsCorrupted">func IsCorrupted(err error) bool</a></dd>
  82. <dd><a href="index.html#New">func New(text string) error</a></dd>
  83. <dd><a href="index.html#NewErrCorrupted">func NewErrCorrupted(fd storage.FileDesc, err error) error</a></dd>
  84. <dd><a href="index.html#SetFd">func SetFd(err error, fd storage.FileDesc) error</a></dd>
  85. <dd><a href="index.html#ErrCorrupted">type ErrCorrupted</a></dd>
  86. <dd>&nbsp; &nbsp; <a href="index.html#ErrCorrupted.Error">func (e *ErrCorrupted) Error() string</a></dd>
  87. <dd><a href="index.html#ErrMissingFiles">type ErrMissingFiles</a></dd>
  88. <dd>&nbsp; &nbsp; <a href="index.html#ErrMissingFiles.Error">func (e *ErrMissingFiles) Error() string</a></dd>
  89. </dl>
  90. </div><!-- #manual-nav -->
  91. <h4>Package files</h4>
  92. <p>
  93. <span style="font-size:90%">
  94. <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go">errors.go</a>
  95. </span>
  96. </p>
  97. </div><!-- .expanded -->
  98. </div><!-- #pkg-index -->
  99. <div id="pkg-callgraph" class="toggle" style="display: none">
  100. <div class="collapsed">
  101. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  102. </div> <!-- .expanded -->
  103. <div class="expanded">
  104. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  105. <p>
  106. In the call graph viewer below, each node
  107. is a function belonging to this package
  108. and its children are the functions it
  109. calls&mdash;perhaps dynamically.
  110. </p>
  111. <p>
  112. The root nodes are the entry points of the
  113. package: functions that may be called from
  114. outside the package.
  115. There may be non-exported or anonymous
  116. functions among them if they are called
  117. dynamically from another package.
  118. </p>
  119. <p>
  120. Click a node to visit that function's source code.
  121. From there you can visit its callers by
  122. clicking its declaring <code>func</code>
  123. token.
  124. </p>
  125. <p>
  126. Functions may be omitted if they were
  127. determined to be unreachable in the
  128. particular programs or tests that were
  129. analyzed.
  130. </p>
  131. <!-- Zero means show all package entry points. -->
  132. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  133. </div>
  134. </div> <!-- #pkg-callgraph -->
  135. <h2 id="pkg-variables">Variables</h2>
  136. <pre>var (
  137. <span id="ErrNotFound">ErrNotFound</span> = <a href="index.html#New">New</a>(&#34;leveldb: not found&#34;)
  138. <span id="ErrReleased">ErrReleased</span> = <a href="../util/index.html">util</a>.<a href="../util/index.html#ErrReleased">ErrReleased</a>
  139. <span id="ErrHasReleaser">ErrHasReleaser</span> = <a href="../util/index.html">util</a>.<a href="../util/index.html#ErrHasReleaser">ErrHasReleaser</a>
  140. )</pre>
  141. <p>
  142. Common errors.
  143. </p>
  144. <h2 id="IsCorrupted">func <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=1191:1223#L41">IsCorrupted</a></h2>
  145. <pre>func IsCorrupted(err <a href="../../../../../builtin/index.html#error">error</a>) <a href="../../../../../builtin/index.html#bool">bool</a></pre>
  146. <p>
  147. IsCorrupted returns a boolean indicating whether the error is indicating
  148. a corruption.
  149. </p>
  150. <h2 id="New">func <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=603:630#L16">New</a></h2>
  151. <pre>func New(text <a href="../../../../../builtin/index.html#string">string</a>) <a href="../../../../../builtin/index.html#error">error</a></pre>
  152. <p>
  153. New returns an error that formats as the given text.
  154. </p>
  155. <h2 id="NewErrCorrupted">func <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=1003:1061#L35">NewErrCorrupted</a></h2>
  156. <pre>func NewErrCorrupted(fd <a href="../storage/index.html">storage</a>.<a href="../storage/index.html#FileDesc">FileDesc</a>, err <a href="../../../../../builtin/index.html#error">error</a>) <a href="../../../../../builtin/index.html#error">error</a></pre>
  157. <p>
  158. NewErrCorrupted creates new ErrCorrupted error.
  159. </p>
  160. <h2 id="SetFd">func <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=1743:1791#L61">SetFd</a></h2>
  161. <pre>func SetFd(err <a href="../../../../../builtin/index.html#error">error</a>, fd <a href="../storage/index.html">storage</a>.<a href="../storage/index.html#FileDesc">FileDesc</a>) <a href="../../../../../builtin/index.html#error">error</a></pre>
  162. <p>
  163. SetFd sets &#39;file info&#39; of the given error with the given file.
  164. Currently only ErrCorrupted is supported, otherwise will do nothing.
  165. </p>
  166. <h2 id="ErrCorrupted">type <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=752:813#L22">ErrCorrupted</a></h2>
  167. <pre>type ErrCorrupted struct {
  168. Fd <a href="../storage/index.html">storage</a>.<a href="../storage/index.html#FileDesc">FileDesc</a>
  169. Err <a href="../../../../../builtin/index.html#error">error</a>
  170. }</pre>
  171. <p>
  172. ErrCorrupted is the type that wraps errors that indicate corruption in
  173. the database.
  174. </p>
  175. <h3 id="ErrCorrupted.Error">func (*ErrCorrupted) <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=815:852#L27">Error</a></h3>
  176. <pre>func (e *<a href="index.html#ErrCorrupted">ErrCorrupted</a>) Error() <a href="../../../../../builtin/index.html#string">string</a></pre>
  177. <h2 id="ErrMissingFiles">type <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=1480:1535#L53">ErrMissingFiles</a></h2>
  178. <pre>type ErrMissingFiles struct {
  179. Fds []<a href="../storage/index.html">storage</a>.<a href="../storage/index.html#FileDesc">FileDesc</a>
  180. }</pre>
  181. <p>
  182. ErrMissingFiles is the type that indicating a corruption due to missing
  183. files. ErrMissingFiles always wrapped with ErrCorrupted.
  184. </p>
  185. <h3 id="ErrMissingFiles.Error">func (*ErrMissingFiles) <a href="http://localhost:6060/src/github.com/syndtr/goleveldb/leveldb/errors/errors.go?s=1537:1577#L57">Error</a></h3>
  186. <pre>func (e *<a href="index.html#ErrMissingFiles">ErrMissingFiles</a>) Error() <a href="../../../../../builtin/index.html#string">string</a></pre>
  187. <div id="footer">
  188. Build version go1.6.<br>
  189. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  190. the content of this page is licensed under the
  191. Creative Commons Attribution 3.0 License,
  192. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  193. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  194. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  195. </div>
  196. </div><!-- .container -->
  197. </div><!-- #page -->
  198. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  199. <script type="text/javascript" src="../../../../../../lib/godoc/jquery.js"></script>
  200. <script type="text/javascript" src="../../../../../../lib/godoc/jquery.treeview.js"></script>
  201. <script type="text/javascript" src="../../../../../../lib/godoc/jquery.treeview.edit.js"></script>
  202. <script type="text/javascript" src="../../../../../../lib/godoc/godocs.js"></script>
  203. </body>
  204. </html>