mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
45 lines
8 KiB
HTML
45 lines
8 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="A rust library for colorizing `tracing_error::SpanTrace` objects in the style of `color-backtrace`."><title>color_spantrace - 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="color_spantrace" 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="../crates.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 mod crate"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../color_spantrace/index.html">color_spantrace</a><span class="version">0.2.1</span></h2></div><div class="sidebar-elems"><ul class="block">
|
|||
|
|
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section></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="../color_spantrace/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>Crate <a class="mod" href="#">color_spantrace</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/color_spantrace/lib.rs.html#1-380">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A rust library for colorizing <a href="https://docs.rs/tracing-error/*/tracing_error/struct.SpanTrace.html"><code>tracing_error::SpanTrace</code></a> objects in the style
|
|||
|
|
of <a href="https://github.com/athre0z/color-backtrace"><code>color-backtrace</code></a>.</p>
|
|||
|
|
<h3 id="setup"><a href="#setup">Setup</a></h3>
|
|||
|
|
<p>Add the following to your <code>Cargo.toml</code>:</p>
|
|||
|
|
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
|
|||
|
|
color-spantrace = "0.2"
|
|||
|
|
tracing = "0.1"
|
|||
|
|
tracing-error = "0.2"
|
|||
|
|
tracing-subscriber = "0.3"
|
|||
|
|
</code></pre></div>
|
|||
|
|
<p>Setup a tracing subscriber with an <code>ErrorLayer</code>:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing_error::ErrorLayer;
|
|||
|
|
<span class="kw">use </span>tracing_subscriber::{prelude::<span class="kw-2">*</span>, registry::Registry};
|
|||
|
|
|
|||
|
|
Registry::default().with(ErrorLayer::default()).init();</code></pre></div>
|
|||
|
|
<p>Create spans and enter them:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing::instrument;
|
|||
|
|
<span class="kw">use </span>tracing_error::SpanTrace;
|
|||
|
|
|
|||
|
|
<span class="attr">#[instrument]
|
|||
|
|
</span><span class="kw">fn </span>foo() -> SpanTrace {
|
|||
|
|
SpanTrace::capture()
|
|||
|
|
}</code></pre></div>
|
|||
|
|
<p>And finally colorize the <code>SpanTrace</code>:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing_error::SpanTrace;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>span_trace = SpanTrace::capture();
|
|||
|
|
<span class="macro">println!</span>(<span class="string">"{}"</span>, color_spantrace::colorize(<span class="kw-2">&</span>span_trace));</code></pre></div>
|
|||
|
|
<h3 id="output-format"><a href="#output-format">Output Format</a></h3>
|
|||
|
|
<p>Running <code>examples/color-spantrace-usage.rs</code> from the <code>color-spantrace</code> repo produces the following output:</p>
|
|||
|
|
<pre><font color="#4E9A06"><b>❯</b></font> cargo run --example color-spantrace-usage
|
|||
|
|
<font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.04s
|
|||
|
|
<font color="#4E9A06"><b> Running</b></font> `target/debug/examples/color-spantrace-usage`
|
|||
|
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ SPANTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|||
|
|
|
|||
|
|
0: <font color="#F15D22">color-spantrace-usage::two</font>
|
|||
|
|
at <font color="#75507B">examples/color-spantrace-usage.rs</font>:<font color="#75507B">18</font>
|
|||
|
|
1: <font color="#F15D22">color-spantrace-usage::one</font> with <font color="#34E2E2">i=42</font>
|
|||
|
|
at <font color="#75507B">examples/color-spantrace-usage.rs</font>:<font color="#75507B">13</font></pre>
|
|||
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.InstallThemeError.html" title="struct color_spantrace::InstallThemeError">InstallThemeError</a></div><div class="desc docblock-short">An error returned by <code>set_theme</code> if a global theme was already set</div></li><li><div class="item-name"><a class="struct" href="struct.Theme.html" title="struct color_spantrace::Theme">Theme</a></div><div class="desc docblock-short">A struct that represents theme that is used by <code>color_spantrace</code></div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.colorize.html" title="fn color_spantrace::colorize">colorize</a></div><div class="desc docblock-short">Display a <a href="https://docs.rs/tracing-error/*/tracing_error/struct.SpanTrace.html"><code>SpanTrace</code></a> with colors and source</div></li><li><div class="item-name"><a class="fn" href="fn.set_theme.html" title="fn color_spantrace::set_theme">set_theme</a></div><div class="desc docblock-short">Sets the global theme.</div></li></ul></section></div></main></body></html>
|