pnmixer-rust/log/macro.debug.html

134 lines
6.2 KiB
HTML
Raw Normal View History

2017-07-14 23:24:09 +00:00
<!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">
2017-07-14 23:30:16 +00:00
<meta name="description" content="API documentation for the Rust `debug` macro in crate `log`.">
<meta name="keywords" content="rust, rustlang, rust-lang, debug">
2017-07-14 23:24:09 +00:00
2017-07-14 23:30:16 +00:00
<title>log::debug - Rust</title>
2017-07-14 23:24:09 +00:00
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
2017-07-14 23:30:16 +00:00
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
2017-07-14 23:24:09 +00:00
</head>
<body class="rustdoc macro">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
2017-07-14 23:30:16 +00:00
<a href='../log/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'><a href='index.html'>log</a></p><script>window.sidebarCurrent = {name: 'debug', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script>
2017-07-14 23:24:09 +00:00
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
2017-07-14 23:30:16 +00:00
<h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>log</a>::<wbr><a class="macro" href=''>debug</a></span><span class='out-of-band'><span id='render-detail'>
2017-07-14 23:24:09 +00:00
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
2017-07-14 23:30:16 +00:00
</span><a class='srclink' href='../src/log/macros.rs.html#166-173' title='goto source code'>[src]</a></span></h1>
2017-07-14 23:24:09 +00:00
<pre class="rust macro">
2017-07-14 23:30:16 +00:00
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">debug</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> { ... };
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> { ... };
2017-07-14 23:24:09 +00:00
}</pre>
2017-07-14 23:30:16 +00:00
<div class='docblock'><p>Logs a message at the debug level.</p>
<p>Logging at this level is disabled if any of the following features are
present: <code>max_level_off</code>, <code>max_level_error</code>, <code>max_level_warn</code>, or
<code>max_level_info</code>.</p>
<p>When building in release mode (i.e., without the <code>debug_assertions</code> option),
logging at this level is also disabled if any of the following features are
present: <code>release_max_level_off</code>, <code>release_max_level_error</code>,
<code>release_max_level_warn</code>, or <code>release_max_level_info</code>.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="ident">pos</span> <span class="op">=</span> <span class="ident">Position</span> { <span class="ident">x</span>: <span class="number">3.234</span>, <span class="ident">y</span>: <span class="op">-</span><span class="number">1.223</span> };
<span class="macro">debug</span><span class="macro">!</span>(<span class="string">&quot;New position: x: {}, y: {}&quot;</span>, <span class="ident">pos</span>.<span class="ident">x</span>, <span class="ident">pos</span>.<span class="ident">y</span>);
<span class="macro">debug</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="string">&quot;app_events&quot;</span>, <span class="string">&quot;New position: x: {}, y: {}&quot;</span>, <span class="ident">pos</span>.<span class="ident">x</span>, <span class="ident">pos</span>.<span class="ident">y</span>);</pre>
2017-07-14 23:24:09 +00:00
</div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
2017-07-14 23:30:16 +00:00
window.currentCrate = "log";
2017-07-14 23:24:09 +00:00
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>