NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-18 16:49:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

Browse source
This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
tracing_log/all.html Normal file
View file

@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</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="tracing_log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.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 mod sys"><!--[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><a class="logo-container" href="../tracing_log/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_log/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing_log/index.html">tracing_<wbr>log</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.LogTracer.html">LogTracer</a></li><li><a href="log_tracer/struct.Builder.html">log_tracer::Builder</a></li><li><a href="log_tracer/struct.LogTracer.html">log_tracer::LogTracer</a></li><li><a href="log_tracer/struct.SetLoggerError.html">log_tracer::SetLoggerError</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.AsLog.html">AsLog</a></li><li><a href="trait.AsTrace.html">AsTrace</a></li><li><a href="trait.NormalizeEvent.html">NormalizeEvent</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="fn.format_trace.html">format_trace</a></li></ul></section></div></main></body></html>

2
tracing_log/fn.format_trace.html Normal file
View file

@ -0,0 +1,2 @@
<!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="Format a log record as a trace event in the current span."><title>format_trace in tracing_log - 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="tracing_log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" 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 fn"><!--[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><a class="logo-container" href="../tracing_log/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_log/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing_log/index.html">tracing_<wbr>log</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></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">tracing_log</a></span><h1>Function <span class="fn">format_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/tracing_log/lib.rs.html#158-161">Source</a> </span></div><pre class="rust item-decl"><code>pub fn format_trace(record: &amp;<a class="struct" href="../log/struct.Record.html" title="struct log::Record">Record</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Format a log record as a trace event in the current span.</p>
</div></details></section></div></main></body></html>

66
tracing_log/index.html Normal file
View file

@ -0,0 +1,66 @@
<!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="Adapters for connecting unstructured log records from the `log` crate into the `tracing` ecosystem."><title>tracing_log - 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="tracing_log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.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 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" title="show sidebar"></button><a class="logo-container" href="../tracing_log/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_log/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing_log/index.html">tracing_<wbr>log</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#overview" title="Overview">Overview</a></li><li><a href="#usage" title="Usage">Usage</a><ul><li><a href="#convert-log-records-to-tracing-events" title="Convert log records to tracing `Event`s">Convert log records to tracing <code>Event</code>s</a></li><li><a href="#convert-tracing-events-to-logs" title="Convert tracing `Event`s to logs">Convert tracing <code>Event</code>s to logs</a></li><li><a href="#caution-mixing-both-conversions" title="Caution: Mixing both conversions">Caution: Mixing both conversions</a></li><li><a href="#feature-flags" title="Feature Flags">Feature Flags</a></li><li><a href="#supported-rust-versions" title="Supported Rust Versions">Supported Rust Versions</a></li></ul></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>tracing_log</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/tracing_log/lib.rs.html#1-600">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Adapters for connecting unstructured log records from the <code>log</code> crate into
the <code>tracing</code> ecosystem.</p>
<h2 id="overview"><a class="doc-anchor" href="#overview">§</a>Overview</h2>
<p><a href="https://crates.io/crates/tracing"><code>tracing</code></a> is a framework for instrumenting Rust programs with context-aware,
structured, event-based diagnostic information. This crate provides
compatibility layers for using <code>tracing</code> alongside the logging facade provided
by the <a href="../log/index.html" title="mod log"><code>log</code></a> crate.</p>
<p>This crate provides:</p>
<ul>
<li><a href="trait.AsTrace.html" title="trait tracing_log::AsTrace"><code>AsTrace</code></a> and <a href="trait.AsLog.html" title="trait tracing_log::AsLog"><code>AsLog</code></a> traits for converting between <code>tracing</code> and <code>log</code> types.</li>
<li><a href="struct.LogTracer.html" title="struct tracing_log::LogTracer"><code>LogTracer</code></a>, a <a href="../log/trait.Log.html" title="trait log::Log"><code>log::Log</code></a> implementation that consumes <a href="../log/struct.Record.html" title="struct log::Record"><code>log::Record</code></a>s
and outputs them as <a href="https://docs.rs/tracing/latest/tracing/struct.Event.html"><code>tracing::Event</code></a>.</li>
</ul>
<p><em>Compiler support: <a href="#supported-rust-versions">requires <code>rustc</code> 1.56+</a></em></p>
<h2 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h2><h3 id="convert-log-records-to-tracing-events"><a class="doc-anchor" href="#convert-log-records-to-tracing-events">§</a>Convert log records to tracing <code>Event</code>s</h3>
<p>To convert <a href="../log/struct.Record.html" title="struct log::Record"><code>log::Record</code></a>s as <a href="https://docs.rs/tracing/latest/tracing/struct.Event.html"><code>tracing::Event</code></a>s, set <code>LogTracer</code> as the default
logger by calling its <a href="struct.LogTracer.html#method.init" title="associated function tracing_log::LogTracer::init"><code>init</code></a> or <a href="struct.LogTracer.html#method.init_with_filter" title="associated function tracing_log::LogTracer::init_with_filter"><code>init_with_filter</code></a> methods.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tracing_log::LogTracer;
<span class="kw">use </span>log;
LogTracer::init()<span class="question-mark">?</span>;
<span class="comment">// will be available for Subscribers as a tracing Event
</span><span class="macro">log::trace!</span>(<span class="string">"an example trace log"</span>);</code></pre></div>
<p>This conversion does not convert unstructured data in log records (such as
values passed as format arguments to the <code>log!</code> macro) to structured
<code>tracing</code> fields. However, it <em>does</em> attach these new events to to the
span that was currently executing when the record was logged. This is the
primary use-case for this library: making it possible to locate the log
records emitted by dependencies which use <code>log</code> within the context of a
trace.</p>
<h3 id="convert-tracing-events-to-logs"><a class="doc-anchor" href="#convert-tracing-events-to-logs">§</a>Convert tracing <code>Event</code>s to logs</h3>
<p>Enabling the <a href="https://docs.rs/tracing/latest/tracing/#crate-feature-flags">“log” and “log-always” feature flags</a> on the <code>tracing</code>
crate will cause all <code>tracing</code> spans and events to emit <code>log::Record</code>s as
they occur.</p>
<h3 id="caution-mixing-both-conversions"><a class="doc-anchor" href="#caution-mixing-both-conversions">§</a>Caution: Mixing both conversions</h3>
<p>Note that <code>log::Logger</code> implementations that convert log records to trace events
should not be used with <code>Subscriber</code>s that convert trace events <em>back</em> into
<code>log</code> records, as doing so will result in the event recursing between the subscriber
and the logger forever (or, in real life, probably overflowing the call stack).</p>
<p>If the logging of trace events generated from log records produced by the
<code>log</code> crate is desired, either the <code>log</code> crate should not be used to
implement this logging, or an additional layer of filtering will be
required to avoid infinitely converting between <code>Event</code> and <code>log::Record</code>.</p>
<h3 id="feature-flags"><a class="doc-anchor" href="#feature-flags">§</a>Feature Flags</h3>
<ul>
<li><code>std</code>: enables features that require the Rust standard library (on by default)</li>
<li><code>log-tracer</code>: enables the <code>LogTracer</code> type (on by default)</li>
<li><code>interest-cache</code>: makes it possible to configure an interest cache for
logs emitted through the <code>log</code> crate (see <a href="log_tracer::Builder::with_interest_cache"><code>Builder::with_interest_cache</code></a>); requires <code>std</code></li>
</ul>
<h3 id="supported-rust-versions"><a class="doc-anchor" href="#supported-rust-versions">§</a>Supported Rust Versions</h3>
<p>Tracing is built against the latest stable release. The minimum supported
version is 1.56. The current Tracing version is not guaranteed to build on
Rust versions earlier than the minimum supported version.</p>
<p>Tracing follows the same compiler support policies as the rest of the Tokio
project. The current stable Rust compiler and the three most recent minor
versions before it will always be supported. For example, if the current
stable compiler version is 1.69, the minimum supported version will not be
increased past 1.66, three minor versions prior. Increasing the minimum
supported compiler version is not considered a semver breaking change as
long as doing so complies with this policy.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.log"><code>pub use <a class="mod" href="../log/index.html" title="mod log">log</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="log_tracer/index.html" title="mod tracing_log::log_tracer">log_<wbr>tracer</a></div><div class="desc docblock-short">An adapter for converting <a href="../log/index.html" title="mod log"><code>log</code></a> records into <code>tracing</code> <code>Event</code>s.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.LogTracer.html" title="struct tracing_log::LogTracer">LogTracer</a></div><div class="desc docblock-short">A simple “logger” that converts all log records into <code>tracing</code> <code>Event</code>s.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.AsLog.html" title="trait tracing_log::AsLog">AsLog</a></div><div class="desc docblock-short">Trait implemented for <code>tracing</code> types that can be converted to a <code>log</code>
equivalent.</div></li><li><div class="item-name"><a class="trait" href="trait.AsTrace.html" title="trait tracing_log::AsTrace">AsTrace</a></div><div class="desc docblock-short">Trait implemented for <code>log</code> types that can be converted to a <code>tracing</code>
equivalent.</div></li><li><div class="item-name"><a class="trait" href="trait.NormalizeEvent.html" title="trait tracing_log::NormalizeEvent">Normalize<wbr>Event</a></div><div class="desc docblock-short">Extends log <code>Event</code>s to provide complete <code>Metadata</code>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.format_trace.html" title="fn tracing_log::format_trace">format_<wbr>trace</a></div><div class="desc docblock-short">Format a log record as a trace event in the current span.</div></li></ul></section></div></main></body></html>

18
tracing_log/log_tracer/index.html Normal file
View file

@ -0,0 +1,18 @@
<!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 adapter for converting `log` records into `tracing` `Event`s."><title>tracing_log::log_tracer - 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="tracing_log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" 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 mod"><!--[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><a class="logo-container" href="../../tracing_log/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_log/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../../tracing_log/index.html">tracing_<wbr>log</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module log_<wbr>tracer</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#usage" title="Usage">Usage</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate tracing_<wbr>log</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">tracing_log</a></span><h1>Module <span>log_tracer</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/tracing_log/log_tracer.rs.html#1-307">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An adapter for converting <a href="../../log/index.html" title="mod log"><code>log</code></a> records into <code>tracing</code> <code>Event</code>s.</p>
<p>This module provides the <a href="../struct.LogTracer.html" title="struct tracing_log::LogTracer"><code>LogTracer</code></a> type which implements <code>log</code>’s <a href="../../log/trait.Log.html" title="trait log::Log">logger
interface</a> by recording log records as <code>tracing</code> <code>Event</code>s. This is intended for
use in conjunction with a <code>tracing</code> <code>Subscriber</code> to consume events from
dependencies that emit <a href="../../log/index.html" title="mod log"><code>log</code></a> records within a trace context.</p>
<h2 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h2>
<p>To create and initialize a <code>LogTracer</code> with the default configurations, use:</p>
<ul>
<li><a href="LogTracer.html#method.init"><code>init</code></a> if you want to convert all logs, regardless of log level,
allowing the tracing <code>Subscriber</code> to perform any filtering</li>
<li><a href="LogTracer.html#method.init_with_filter"><code>init_with_filter</code></a> to convert all logs up to a specified log level</li>
</ul>
<p>In addition, a <a href="../struct.LogTracer.html#method.builder" title="associated function tracing_log::LogTracer::builder">builder</a> is available for cases where more advanced
configuration is required. In particular, the builder can be used to <a href="struct.Builder.html#method.ignore_crate" title="method tracing_log::log_tracer::Builder::ignore_crate">ignore
log records</a> emitted by particular crates. This is useful in cases
such as when a crate emits both <code>tracing</code> diagnostics <em>and</em> log records by
default.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Builder.html" title="struct tracing_log::log_tracer::Builder">Builder</a></div><div class="desc docblock-short">Configures a new <code>LogTracer</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.LogTracer.html" title="struct tracing_log::log_tracer::LogTracer">LogTracer</a></div><div class="desc docblock-short">A simple “logger” that converts all log records into <code>tracing</code> <code>Event</code>s.</div></li><li><div class="item-name"><a class="struct" href="struct.SetLoggerError.html" title="struct tracing_log::log_tracer::SetLoggerError">SetLogger<wbr>Error</a></div><div class="desc docblock-short">The type returned by <a href="fn.set_logger.html"><code>set_logger</code></a> if <a href="fn.set_logger.html"><code>set_logger</code></a> has already been called.</div></li></ul></section></div></main></body></html>

1
tracing_log/log_tracer/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["Builder","LogTracer","SetLoggerError"]};

31
tracing_log/log_tracer/struct.Builder.html Normal file
View file

File diff suppressed because one or more lines are too long

62
tracing_log/log_tracer/struct.LogTracer.html Normal file
View file

File diff suppressed because one or more lines are too long

13
tracing_log/log_tracer/struct.SetLoggerError.html Normal file
View file

File diff suppressed because one or more lines are too long

1
tracing_log/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"fn":["format_trace"],"mod":["log_tracer"],"struct":["LogTracer"],"trait":["AsLog","AsTrace","NormalizeEvent"]};

62
tracing_log/struct.LogTracer.html Normal file
View file

File diff suppressed because one or more lines are too long

10
tracing_log/trait.AsLog.html Normal file
View file

@ -0,0 +1,10 @@
<!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="Trait implemented for `tracing` types that can be converted to a `log` equivalent."><title>AsLog in tracing_log - 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="tracing_log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" 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><a class="logo-container" href="../tracing_log/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_log/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing_log/index.html">tracing_<wbr>log</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">AsLog</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Log" title="Log">Log</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.as_log" title="as_log">as_log</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-AsLog-for-Level" title="Level">Level</a></li><li><a href="#impl-AsLog-for-LevelFilter" title="LevelFilter">LevelFilter</a></li><li><a href="#impl-AsLog-for-Metadata%3C'a%3E" title="Metadata&#60;&#39;a&#62;">Metadata&#60;&#39;a&#62;</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate tracing_<wbr>log</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">tracing_log</a></span><h1>Trait <span class="trait">AsLog</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/tracing_log/lib.rs.html#198-203">Source</a> </span></div><pre class="rust item-decl"><code>pub trait AsLog: Sealed {
type <a href="#associatedtype.Log" class="associatedtype">Log</a>;
// Required method
fn <a href="#tymethod.as_log" class="fn">as_log</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.AsLog.html#associatedtype.Log" title="type tracing_log::AsLog::Log">Log</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait implemented for <code>tracing</code> types that can be converted to a <code>log</code>
equivalent.</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.Log" class="method"><a class="src rightside" href="../src/tracing_log/lib.rs.html#200">Source</a><h4 class="code-header">type <a href="#associatedtype.Log" class="associatedtype">Log</a></h4></section></summary><div class="docblock"><p>The <code>log</code> type that this type can be converted into.</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.as_log" class="method"><a class="src rightside" href="../src/tracing_log/lib.rs.html#202">Source</a><h4 class="code-header">fn <a href="#tymethod.as_log" class="fn">as_log</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.AsLog.html#associatedtype.Log" title="type tracing_log::AsLog::Log">Log</a></h4></section></summary><div class="docblock"><p>Returns the <code>log</code> equivalent of <code>self</code>.</p>
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-AsLog-for-Level" class="impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#376-387">Source</a><a href="#impl-AsLog-for-Level" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AsLog.html" title="trait tracing_log::AsLog">AsLog</a> for <a class="struct" href="../tracing_core/metadata/struct.Level.html" title="struct tracing_core::metadata::Level">Level</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Log-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#377">Source</a><a href="#associatedtype.Log-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Log" class="associatedtype">Log</a> = <a class="enum" href="../log/enum.Level.html" title="enum log::Level">Level</a></h4></section><section id="method.as_log" class="method trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#378-386">Source</a><a href="#method.as_log" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.as_log" class="fn">as_log</a>(&amp;self) -&gt; <a class="enum" href="../log/enum.Level.html" title="enum log::Level">Level</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsLog-for-LevelFilter" class="impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#424-437">Source</a><a href="#impl-AsLog-for-LevelFilter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AsLog.html" title="trait tracing_log::AsLog">AsLog</a> for <a class="struct" href="../tracing_core/metadata/struct.LevelFilter.html" title="struct tracing_core::metadata::LevelFilter">LevelFilter</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Log-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#425">Source</a><a href="#associatedtype.Log-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Log" class="associatedtype">Log</a> = <a class="enum" href="../log/enum.LevelFilter.html" title="enum log::LevelFilter">LevelFilter</a></h4></section><section id="method.as_log-1" class="method trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#427-436">Source</a><a href="#method.as_log-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.as_log" class="fn">as_log</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.AsLog.html#associatedtype.Log" title="type tracing_log::AsLog::Log">Log</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsLog-for-Metadata%3C'a%3E" class="impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#216-224">Source</a><a href="#impl-AsLog-for-Metadata%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.AsLog.html" title="trait tracing_log::AsLog">AsLog</a> for <a class="struct" href="../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata">Metadata</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Log-3" class="associatedtype trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#217">Source</a><a href="#associatedtype.Log-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Log" class="associatedtype">Log</a> = <a class="struct" href="../log/struct.Metadata.html" title="struct log::Metadata">Metadata</a>&lt;'a&gt;</h4></section><section id="method.as_log-2" class="method trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#218-223">Source</a><a href="#method.as_log-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.as_log" class="fn">as_log</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.AsLog.html#associatedtype.Log" title="type tracing_log::AsLog::Log">Log</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/tracing_log/trait.AsLog.js" data-ignore-extern-crates="tracing_core" async></script></section></div></main></body></html>

10
tracing_log/trait.AsTrace.html Normal file
View file

File diff suppressed because one or more lines are too long

23
tracing_log/trait.NormalizeEvent.html Normal file
View file

@ -0,0 +1,23 @@
<!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="Extends log `Event`s to provide complete `Metadata`."><title>NormalizeEvent in tracing_log - 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="tracing_log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" 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><a class="logo-container" href="../tracing_log/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_log/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../tracing_log/index.html">tracing_<wbr>log</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Normalize<wbr>Event</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_log" title="is_log">is_log</a></li><li><a href="#tymethod.normalized_metadata" title="normalized_metadata">normalized_metadata</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-NormalizeEvent%3C'a%3E-for-Event%3C'a%3E" title="Event&#60;&#39;a&#62;">Event&#60;&#39;a&#62;</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate tracing_<wbr>log</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">tracing_log</a></span><h1>Trait <span class="trait">NormalizeEvent</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/tracing_log/lib.rs.html#455-464">Source</a> </span></div><pre class="rust item-decl"><code>pub trait NormalizeEvent&lt;'a&gt;: Sealed {
// Required methods
fn <a href="#tymethod.normalized_metadata" class="fn">normalized_metadata</a>(&amp;'a self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata">Metadata</a>&lt;'a&gt;&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.is_log" class="fn">is_log</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.bool.html">bool</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extends log <code>Event</code>s to provide complete <code>Metadata</code>.</p>
<p>In <code>tracing-log</code>, an <code>Event</code> produced by a log (through <a href="trait.AsTrace.html" title="trait tracing_log::AsTrace"><code>AsTrace</code></a>) has an hard coded
“log” target and no <code>file</code>, <code>line</code>, or <code>module_path</code> attributes. This happens because <code>Event</code>
requires its <code>Metadata</code> to be <code>'static</code>, while <a href="../log/struct.Record.html" title="struct log::Record"><code>log::Record</code></a>s provide them with a generic
lifetime.</p>
<p>However, these values are stored in the <code>Event</code>’s fields and
the <a href="trait.NormalizeEvent.html#normalized_metadata" title="trait tracing_log::NormalizeEvent"><code>normalized_metadata</code></a> method allows to build a new <code>Metadata</code>
that only lives as long as its source <code>Event</code>, but provides complete
data.</p>
<p>It can typically be used by <code>Subscriber</code>s when processing an <code>Event</code>,
to allow accessing its complete metadata in a consistent way,
regardless of the source of its source.</p>
</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.normalized_metadata" class="method"><a class="src rightside" href="../src/tracing_log/lib.rs.html#461">Source</a><h4 class="code-header">fn <a href="#tymethod.normalized_metadata" class="fn">normalized_metadata</a>(&amp;'a self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata">Metadata</a>&lt;'a&gt;&gt;</h4></section></summary><div class="docblock"><p>If this <code>Event</code> comes from a <code>log</code>, this method provides a new
normalized <code>Metadata</code> which has all available attributes
from the original log, including <code>file</code>, <code>line</code>, <code>module_path</code>
and <code>target</code>.
Returns <code>None</code> is the <code>Event</code> is not issued from a <code>log</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_log" class="method"><a class="src rightside" href="../src/tracing_log/lib.rs.html#463">Source</a><h4 class="code-header">fn <a href="#tymethod.is_log" class="fn">is_log</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether this <code>Event</code> represents a log (from the <code>log</code> crate)</p>
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-NormalizeEvent%3C'a%3E-for-Event%3C'a%3E" class="impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#468-493">Source</a><a href="#impl-NormalizeEvent%3C'a%3E-for-Event%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.NormalizeEvent.html" title="trait tracing_log::NormalizeEvent">NormalizeEvent</a>&lt;'a&gt; for <a class="struct" href="../tracing_core/event/struct.Event.html" title="struct tracing_core::event::Event">Event</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><section id="method.normalized_metadata" class="method trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#469-488">Source</a><a href="#method.normalized_metadata" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.normalized_metadata" class="fn">normalized_metadata</a>(&amp;'a self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../tracing_core/metadata/struct.Metadata.html" title="struct tracing_core::metadata::Metadata">Metadata</a>&lt;'a&gt;&gt;</h4></section><section id="method.is_log" class="method trait-impl"><a class="src rightside" href="../src/tracing_log/lib.rs.html#490-492">Source</a><a href="#method.is_log" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_log" class="fn">is_log</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/tracing_log/trait.NormalizeEvent.js" data-ignore-extern-crates="tracing_core" async></script></section></div></main></body></html>