struct.Error.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `Error` struct in crate `failure`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, Error">
  9. <title>failure::Error - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. </head>
  16. <body class="rustdoc struct">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Struct Error</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.cause">cause</a><a href="#method.backtrace">backtrace</a><a href="#method.context">context</a><a href="#method.compat">compat</a><a href="#method.downcast">downcast</a><a href="#method.root_cause">root_cause</a><a href="#method.downcast_ref">downcast_ref</a><a href="#method.downcast_mut">downcast_mut</a><a href="#method.causes">causes</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3CError%3E">From&lt;Error&gt;</a><a href="#impl-ResultExt%3CT%2C%20Error%3E">ResultExt&lt;T, Error&gt;</a><a href="#impl-From%3CF%3E">From&lt;F&gt;</a><a href="#impl-Display">Display</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='index.html'>failure</a></p><script>window.sidebarCurrent = {name: 'Error', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>failure</a>::<wbr><a class="struct" href=''>Error</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../src/failure/error.rs.html#21-23' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust struct'>pub struct Error { /* fields omitted */ }</pre><div class='docblock'><p>The <code>Error</code> type, which can contain any failure.</p>
  51. <p>Functions which accumulate many kinds of errors should return this type.
  52. All failures can be converted into it, so functions which catch those
  53. errors can be tried with <code>?</code> inside of a function that returns this kind
  54. of error.</p>
  55. <p>In addition to implementing <code>Debug</code> and <code>Display</code>, this type carries <code>Backtrace</code>
  56. information, and can be downcast into the failure that underlies it for
  57. more detailed inspection.</p>
  58. </div>
  59. <h2 id='methods' class='small-section-header'>
  60. Methods<a href='#methods' class='anchor'></a>
  61. </h2>
  62. <h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#42-138' title='goto source code'>[src]</a></span></h3>
  63. <div class='impl-items'><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><code>pub fn <a href='#method.cause' class='fnname'>cause</a>(&amp;self) -&gt; &amp;<a class="trait" href="../failure/trait.Fail.html" title="trait failure::Fail">Fail</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#46-48' title='goto source code'>[src]</a></span></h4>
  64. <div class='docblock'><p>Returns a reference to the underlying cause of this <code>Error</code>. Unlike the
  65. method on <code>Fail</code>, this does not return an <code>Option</code>. The <code>Error</code> type
  66. always has an underlying failure.</p>
  67. </div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><code>pub fn <a href='#method.backtrace' class='fnname'>backtrace</a>(&amp;self) -&gt; &amp;<a class="struct" href="../failure/struct.Backtrace.html" title="struct failure::Backtrace">Backtrace</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#55-57' title='goto source code'>[src]</a></span></h4>
  68. <div class='docblock'><p>Gets a reference to the <code>Backtrace</code> for this <code>Error</code>.</p>
  69. <p>If the failure this wrapped carried a backtrace, that backtrace will
  70. be returned. Otherwise, the backtrace will have been constructed at
  71. the point that failure was cast into the <code>Error</code> type.</p>
  72. </div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><code>pub fn <a href='#method.context' class='fnname'>context</a>&lt;D:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;context: D<br>) -&gt; <a class="struct" href="../failure/struct.Context.html" title="struct failure::Context">Context</a>&lt;D&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#72-74' title='goto source code'>[src]</a></span></h4>
  73. <div class='docblock'><p>Provides context for this <code>Error</code>.</p>
  74. <p>This can provide additional information about this error, appropriate
  75. to the semantics of the current layer. That is, if you have a
  76. lower-level error, such as an IO error, you can provide additional context
  77. about what that error means in the context of your function. This
  78. gives users of this function more information about what has gone
  79. wrong.</p>
  80. <p>This takes any type that implements <code>Display</code>, as well as
  81. <code>Send</code>/<code>Sync</code>/<code>'static</code>. In practice, this means it can take a <code>String</code>
  82. or a string literal, or a failure, or some other custom context-carrying
  83. type.</p>
  84. </div><h4 id='method.compat' class="method"><span id='compat.v' class='invisible'><code>pub fn <a href='#method.compat' class='fnname'>compat</a>(self) -&gt; <a class="struct" href="../failure/struct.Compat.html" title="struct failure::Compat">Compat</a>&lt;<a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#81-83' title='goto source code'>[src]</a></span></h4>
  85. <div class='docblock'><p>Wraps <code>Error</code> in a compatibility type.</p>
  86. <p>This type implements the <code>Error</code> trait from <code>std::error</code>. If you need
  87. to pass failure's <code>Error</code> to an interface that takes any <code>Error</code>, you
  88. can use this method to get a compatible type.</p>
  89. </div><h4 id='method.downcast' class="method"><span id='downcast.v' class='invisible'><code>pub fn <a href='#method.downcast' class='fnname'>downcast</a>&lt;T:&nbsp;<a class="trait" href="../failure/trait.Fail.html" title="trait failure::Fail">Fail</a>&gt;(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#91-108' title='goto source code'>[src]</a></span></h4>
  90. <div class='docblock'><p>Attempts to downcast this <code>Error</code> to a particular <code>Fail</code> type.</p>
  91. <p>This downcasts by value, returning an owned <code>T</code> if the underlying
  92. failure is of the type <code>T</code>. For this reason it returns a <code>Result</code> - in
  93. the case that the underlying error is of a different type, the
  94. original <code>Error</code> is returned.</p>
  95. </div><h4 id='method.root_cause' class="method"><span id='root_cause.v' class='invisible'><code>pub fn <a href='#method.root_cause' class='fnname'>root_cause</a>(&amp;self) -&gt; &amp;<a class="trait" href="../failure/trait.Fail.html" title="trait failure::Fail">Fail</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
  96. <div class='docblock'><p>Returns the &quot;root cause&quot; of this error - the last value in the
  97. cause chain which does not return an underlying <code>cause</code>.</p>
  98. </div><h4 id='method.downcast_ref' class="method"><span id='downcast_ref.v' class='invisible'><code>pub fn <a href='#method.downcast_ref' class='fnname'>downcast_ref</a>&lt;T:&nbsp;<a class="trait" href="../failure/trait.Fail.html" title="trait failure::Fail">Fail</a>&gt;(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#120-122' title='goto source code'>[src]</a></span></h4>
  99. <div class='docblock'><p>Attempts to downcast this <code>Error</code> to a particular <code>Fail</code> type by
  100. reference.</p>
  101. <p>If the underlying error is not of type <code>T</code>, this will return <code>None</code>.</p>
  102. </div><h4 id='method.downcast_mut' class="method"><span id='downcast_mut.v' class='invisible'><code>pub fn <a href='#method.downcast_mut' class='fnname'>downcast_mut</a>&lt;T:&nbsp;<a class="trait" href="../failure/trait.Fail.html" title="trait failure::Fail">Fail</a>&gt;(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#128-130' title='goto source code'>[src]</a></span></h4>
  103. <div class='docblock'><p>Attempts to downcast this <code>Error</code> to a particular <code>Fail</code> type by
  104. mutable reference.</p>
  105. <p>If the underlying error is not of type <code>T</code>, this will return <code>None</code>.</p>
  106. </div><h4 id='method.causes' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../failure/struct.Causes.html" title="struct failure::Causes">Causes</a>&lt;'f&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../failure/struct.Causes.html" title="struct failure::Causes">Causes</a>&lt;'f&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'f&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../failure/struct.Causes.html" title="struct failure::Causes">Causes</a>&lt;'f&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &amp;'f <a class="trait" href="../failure/trait.Fail.html" title="trait failure::Fail">Fail</a>;</span></code></div></div><span id='causes.v' class='invisible'><code>pub fn <a href='#method.causes' class='fnname'>causes</a>(&amp;self) -&gt; <a class="struct" href="../failure/struct.Causes.html" title="struct failure::Causes">Causes</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#135-137' title='goto source code'>[src]</a></span></h4>
  107. <div class='docblock'><p>Returns a iterator over the causes of the <code>Error</code>, beginning with
  108. the failure returned by the <code>cause</code> method and ending with the failure
  109. returned by <code>root_cause</code>.</p>
  110. </div></div>
  111. <h2 id='implementations' class='small-section-header'>
  112. Trait Implementations<a href='#implementations' class='anchor'></a>
  113. </h2>
  114. <h3 id='impl-From%3CError%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>&gt; for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">StdError</a>&gt;</code><a href='#impl-From%3CError%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/compat.rs.html#37-41' title='goto source code'>[src]</a></span></h3>
  115. <div class='impl-items'><h4 id='method.from' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;R&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;W&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;W&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;I&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;I&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &lt;I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(error: <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">StdError</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/compat.rs.html#38-40' title='goto source code'>[src]</a></span></h4>
  116. <div class='docblock'><p>Performs the conversion.</p>
  117. </div></div><h3 id='impl-ResultExt%3CT%2C%20Error%3E' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="../failure/trait.ResultExt.html" title="trait failure::ResultExt">ResultExt</a>&lt;T, <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>&gt; for <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>&gt;</code><a href='#impl-ResultExt%3CT%2C%20Error%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/result_ext.rs.html#49-69' title='goto source code'>[src]</a></span></h3>
  118. <div class='impl-items'><h4 id='method.compat-1' class="method"><span id='compat.v-1' class='invisible'><code>fn <a href='../failure/trait.ResultExt.html#tymethod.compat' class='fnname'>compat</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="../failure/struct.Compat.html" title="struct failure::Compat">Compat</a>&lt;<a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/result_ext.rs.html#50-52' title='goto source code'>[src]</a></span></h4>
  119. <div class='docblock'><p>Wraps the error in <code>Compat</code> to make it compatible with older error handling APIs that expect <code>std::error::Error</code>. <a href="../failure/trait.ResultExt.html#tymethod.compat">Read more</a></p>
  120. </div><h4 id='method.context-1' class="method"><span id='context.v-1' class='invisible'><code>fn <a href='../failure/trait.ResultExt.html#tymethod.context' class='fnname'>context</a>&lt;D&gt;(self, context: D) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="../failure/struct.Context.html" title="struct failure::Context">Context</a>&lt;D&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/result_ext.rs.html#54-58' title='goto source code'>[src]</a></span></h4>
  121. <div class='docblock'><p>Wraps the error type in a context type.</p>
  122. </div><h4 id='method.with_context' class="method"><span id='with_context.v' class='invisible'><code>fn <a href='../failure/trait.ResultExt.html#tymethod.with_context' class='fnname'>with_context</a>&lt;F, D&gt;(self, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="struct" href="../failure/struct.Context.html" title="struct failure::Context">Context</a>&lt;D&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&amp;<a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a>) -&gt; D,<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/result_ext.rs.html#60-68' title='goto source code'>[src]</a></span></h4>
  123. <div class='docblock'><p>Wraps the error type in a context type generated by looking at the error value. <a href="../failure/trait.ResultExt.html#tymethod.with_context">Read more</a></p>
  124. </div></div><h3 id='impl-From%3CF%3E' class='impl'><span class='in-band'><code>impl&lt;F:&nbsp;<a class="trait" href="../failure/trait.Fail.html" title="trait failure::Fail">Fail</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;F&gt; for <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a></code><a href='#impl-From%3CF%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#30-40' title='goto source code'>[src]</a></span></h3>
  125. <div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(failure: F) -&gt; <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#31-39' title='goto source code'>[src]</a></span></h4>
  126. <div class='docblock'><p>Performs the conversion.</p>
  127. </div></div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#140-144' title='goto source code'>[src]</a></span></h3>
  128. <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#141-143' title='goto source code'>[src]</a></span></h4>
  129. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
  130. </div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../failure/struct.Error.html" title="struct failure::Error">Error</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#146-154' title='goto source code'>[src]</a></span></h3>
  131. <div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/failure/error.rs.html#147-153' title='goto source code'>[src]</a></span></h4>
  132. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
  133. </div></div></section>
  134. <section id='search' class="content hidden"></section>
  135. <section class="footer"></section>
  136. <aside id="help" class="hidden">
  137. <div>
  138. <h1 class="hidden">Help</h1>
  139. <div class="shortcuts">
  140. <h2>Keyboard Shortcuts</h2>
  141. <dl>
  142. <dt><kbd>?</kbd></dt>
  143. <dd>Show this help dialog</dd>
  144. <dt><kbd>S</kbd></dt>
  145. <dd>Focus the search field</dd>
  146. <dt><kbd>↑</kbd></dt>
  147. <dd>Move up in search results</dd>
  148. <dt><kbd>↓</kbd></dt>
  149. <dd>Move down in search results</dd>
  150. <dt><kbd>↹</kbd></dt>
  151. <dd>Switch tab</dd>
  152. <dt><kbd>&#9166;</kbd></dt>
  153. <dd>Go to active search result</dd>
  154. <dt><kbd>+</kbd></dt>
  155. <dd>Expand all sections</dd>
  156. <dt><kbd>-</kbd></dt>
  157. <dd>Collapse all sections</dd>
  158. </dl>
  159. </div>
  160. <div class="infos">
  161. <h2>Search Tricks</h2>
  162. <p>
  163. Prefix searches with a type followed by a colon (e.g.
  164. <code>fn:</code>) to restrict the search to a given type.
  165. </p>
  166. <p>
  167. Accepted types are: <code>fn</code>, <code>mod</code>,
  168. <code>struct</code>, <code>enum</code>,
  169. <code>trait</code>, <code>type</code>, <code>macro</code>,
  170. and <code>const</code>.
  171. </p>
  172. <p>
  173. Search functions by type signature (e.g.
  174. <code>vec -> usize</code> or <code>* -> vec</code>)
  175. </p>
  176. </div>
  177. </div>
  178. </aside>
  179. <script>
  180. window.rootPath = "../";
  181. window.currentCrate = "failure";
  182. </script>
  183. <script src="../main.js"></script>
  184. <script defer src="../search-index.js"></script>
  185. </body>
  186. </html>