30 lines
9.6 KiB
HTML
30 lines
9.6 KiB
HTML
<!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="An error type which can add additional “trace” information to itself."><title>Trace in rancor - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rancor" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../rancor/index.html">rancor</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Trace</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.trace" title="trace">trace</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rancor</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">rancor</a></span><h1>Trait <span class="trait">Trace</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/rancor/lib.rs.html#70-75">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Trace:
|
||
<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>
|
||
+ <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
||
+ <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
|
||
+ 'static {
|
||
// Required method
|
||
fn <a href="#tymethod.trace" class="fn">trace</a><R>(self, trace: R) -> Self
|
||
<span class="where">where R: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static</span>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An error type which can add additional “trace” information to itself.</p>
|
||
<p>Some functions only add additional context to errors created by other
|
||
functions, rather than creating errors themselves. With generics, it’s
|
||
therefore possible to have a generic function which can produce errors with
|
||
some type arguments but not with others. In these cases, <code>Trace</code> allows
|
||
those functions to add context if an error can occur, and compile out the
|
||
context if the error type is <a href="enum.Infallible.html" title="enum rancor::Infallible"><code>Infallible</code></a> or <a href="enum.Panic.html" title="enum rancor::Panic"><code>Panic</code></a>.</p>
|
||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rancor::{ResultExt, Trace};
|
||
|
||
<span class="kw">trait </span>Print<E> {
|
||
<span class="kw">fn </span>print(<span class="kw-2">&</span><span class="self">self</span>, message: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><(), E>;
|
||
}
|
||
|
||
<span class="kw">fn </span>print_hello_world<T: Print<E>, E: Trace>(printer: <span class="kw-2">&</span>T) -> <span class="prelude-ty">Result</span><(), E> {
|
||
printer.print(<span class="string">"hello"</span>).trace(<span class="string">"failed to print hello"</span>)<span class="question-mark">?</span>;
|
||
printer.print(<span class="string">"world"</span>).trace(<span class="string">"failed to print world"</span>)<span class="question-mark">?</span>;
|
||
<span class="prelude-val">Ok</span>(())
|
||
}</code></pre></div>
|
||
</div></details><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.trace" class="method"><a class="src rightside" href="../src/rancor/lib.rs.html#72-74">Source</a><h4 class="code-header">fn <a href="#tymethod.trace" class="fn">trace</a><R>(self, trace: R) -> Self<div class="where">where
|
||
R: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,</div></h4></section></summary><div class="docblock"><p>Adds an additional trace to this error, returning a new error.</p>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Trace-for-Infallible" class="impl"><a class="src rightside" href="../src/rancor/lib.rs.html#610-617">Source</a><a href="#impl-Trace-for-Infallible" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Trace.html" title="trait rancor::Trace">Trace</a> for <a class="enum" href="enum.Infallible.html" title="enum rancor::Infallible">Infallible</a></h3></section><section id="impl-Trace-for-Panic" class="impl"><a class="src rightside" href="../src/rancor/lib.rs.html#637-644">Source</a><a href="#impl-Trace-for-Panic" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Trace.html" title="trait rancor::Trace">Trace</a> for <a class="enum" href="enum.Panic.html" title="enum rancor::Panic">Panic</a></h3></section><section id="impl-Trace-for-BoxedError" class="impl"><a class="src rightside" href="../src/rancor/boxed_error.rs.html#53-67">Source</a><a href="#impl-Trace-for-BoxedError" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Trace.html" title="trait rancor::Trace">Trace</a> for <a class="struct" href="struct.BoxedError.html" title="struct rancor::BoxedError">BoxedError</a></h3></section><section id="impl-Trace-for-Error" class="impl"><a class="src rightside" href="../src/rancor/lib.rs.html#718-727">Source</a><a href="#impl-Trace-for-Error" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Trace.html" title="trait rancor::Trace">Trace</a> for <a class="struct" href="struct.Error.html" title="struct rancor::Error">Error</a></h3></section><section id="impl-Trace-for-Failure" class="impl"><a class="src rightside" href="../src/rancor/lib.rs.html#665-672">Source</a><a href="#impl-Trace-for-Failure" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Trace.html" title="trait rancor::Trace">Trace</a> for <a class="struct" href="struct.Failure.html" title="struct rancor::Failure">Failure</a></h3></section></div><script src="../trait.impl/rancor/trait.Trace.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |