edlang/tracing_error/trait.InstrumentError.html
2024-02-13 06:38:44 +00:00

20 lines
8.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Extension trait for instrumenting errors with `SpanTrace`s"><title>InstrumentError in tracing_error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="tracing_error" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../tracing_error/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../tracing_error/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing_error/index.html">tracing_error</a><span class="version">0.2.0</span></h2></div><h2 class="location"><a href="#">InstrumentError</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Instrumented">Instrumented</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.in_current_span">in_current_span</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate tracing_error</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../tracing_error/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">tracing_error</a>::<wbr><a class="trait" href="#">InstrumentError</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/tracing_error/error.rs.html#195-214">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait InstrumentError {
type <a href="#associatedtype.Instrumented" class="associatedtype">Instrumented</a>;
// Required method
fn <a href="#tymethod.in_current_span" class="fn">in_current_span</a>(self) -&gt; Self::<a class="associatedtype" href="trait.InstrumentError.html#associatedtype.Instrumented" title="type tracing_error::InstrumentError::Instrumented">Instrumented</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait for instrumenting errors with <code>SpanTrace</code>s</p>
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Instrumented" class="method"><a class="src rightside" href="../src/tracing_error/error.rs.html#197">source</a><h4 class="code-header">type <a href="#associatedtype.Instrumented" class="associatedtype">Instrumented</a></h4></section></summary><div class="docblock"><p>The type of the wrapped error after instrumentation</p>
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.in_current_span" class="method"><a class="src rightside" href="../src/tracing_error/error.rs.html#213">source</a><h4 class="code-header">fn <a href="#tymethod.in_current_span" class="fn">in_current_span</a>(self) -&gt; Self::<a class="associatedtype" href="trait.InstrumentError.html#associatedtype.Instrumented" title="type tracing_error::InstrumentError::Instrumented">Instrumented</a></h4></section></summary><div class="docblock"><p>Instrument an Error by bundling it with a SpanTrace</p>
<h5 id="examples"><a href="#examples">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing_error::{TracedError, InstrumentError};
<span class="kw">fn </span>wrap_error&lt;E&gt;(e: E) -&gt; TracedError&lt;E&gt;
<span class="kw">where
</span>E: std::error::Error + Send + Sync + <span class="lifetime">'static
</span>{
e.in_current_span()
}</code></pre></div>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-InstrumentError-for-E" class="impl"><a class="src rightside" href="../src/tracing_error/error.rs.html#273-282">source</a><a href="#impl-InstrumentError-for-E" class="anchor">§</a><h3 class="code-header">impl&lt;E&gt; <a class="trait" href="trait.InstrumentError.html" title="trait tracing_error::InstrumentError">InstrumentError</a> for E<div class="where">where
<a class="struct" href="struct.TracedError.html" title="struct tracing_error::TracedError">TracedError</a>&lt;E&gt;: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;E&gt;,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Instrumented-1" class="associatedtype trait-impl"><a href="#associatedtype.Instrumented-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Instrumented" class="associatedtype">Instrumented</a> = <a class="struct" href="struct.TracedError.html" title="struct tracing_error::TracedError">TracedError</a>&lt;E&gt;</h4></section></div></details></div><script src="../trait.impl/tracing_error/error/trait.InstrumentError.js" async></script></section></div></main></body></html>