edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-23 08:28:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/tracing_log/log_tracer/index.html
edg-l 4cc2814406 deploy: 03a244db41
2024-05-05 09:43:20 +00:00

19 lines
7.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="An adapter for converting `log` records into `tracing` `Event`s."><title>tracing_log::log_tracer - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<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">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.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.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.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"><!--[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_log</a><span class="version">0.2.0</span></h2></div><h2 class="location"><a href="#">Module log_tracer</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate tracing_log</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_log/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>Module <a href="../index.html">tracing_log</a>::<wbr><a class="mod" href="#">log_tracer</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_log/log_tracer.rs.html#1-307">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></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">SetLoggerError</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>
Reference in a new issue View git blame Copy permalink