198 lines
17 KiB
HTML
198 lines
17 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="API documentation for the Rust `RecordBuilder` struct in crate `log`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, RecordBuilder">
|
|||
|
|
|
|||
|
|
<title>log::RecordBuilder - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
<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'>Struct RecordBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.args">args</a><a href="#method.metadata">metadata</a><a href="#method.level">level</a><a href="#method.target">target</a><a href="#method.module_path">module_path</a><a href="#method.file">file</a><a href="#method.line">line</a><a href="#method.build">build</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='index.html'>log</a></p><script>window.sidebarCurrent = {name: 'RecordBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../theme.js"></script>
|
|||
|
|
<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">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>log</a>::<wbr><a class="struct" href=''>RecordBuilder</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/log/lib.rs.html#809-811' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct RecordBuilder<'a> { /* fields omitted */ }</pre><div class='docblock'><p>Builder for <a href="struct.Record.html"><code>Record</code></a>.</p>
|
|||
|
|
<p>Typically should only be used by log library creators or for testing and "shim loggers".
|
|||
|
|
The <code>RecordBuilder</code> can set the different parameters of <code>Record</code> object, and returns
|
|||
|
|
the created object when <code>build</code> is called.</p>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">log</span>::{<span class="ident">Level</span>, <span class="ident">Record</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">record</span> <span class="op">=</span> <span class="ident">Record</span>::<span class="ident">builder</span>()
|
|||
|
|
.<span class="ident">args</span>(<span class="macro">format_args</span><span class="macro">!</span>(<span class="string">"Error!"</span>))
|
|||
|
|
.<span class="ident">level</span>(<span class="ident">Level</span>::<span class="ident">Error</span>)
|
|||
|
|
.<span class="ident">target</span>(<span class="string">"myApp"</span>)
|
|||
|
|
.<span class="ident">file</span>(<span class="prelude-val">Some</span>(<span class="string">"server.rs"</span>))
|
|||
|
|
.<span class="ident">line</span>(<span class="prelude-val">Some</span>(<span class="number">144</span>))
|
|||
|
|
.<span class="ident">module_path</span>(<span class="prelude-val">Some</span>(<span class="string">"server"</span>))
|
|||
|
|
.<span class="ident">build</span>();</pre>
|
|||
|
|
<p>Alternatively, use <a href="struct.MetadataBuilder.html"><code>MetadataBuilder</code></a>:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">log</span>::{<span class="ident">Record</span>, <span class="ident">Level</span>, <span class="ident">MetadataBuilder</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">error_metadata</span> <span class="op">=</span> <span class="ident">MetadataBuilder</span>::<span class="ident">new</span>()
|
|||
|
|
.<span class="ident">target</span>(<span class="string">"myApp"</span>)
|
|||
|
|
.<span class="ident">level</span>(<span class="ident">Level</span>::<span class="ident">Error</span>)
|
|||
|
|
.<span class="ident">build</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">record</span> <span class="op">=</span> <span class="ident">Record</span>::<span class="ident">builder</span>()
|
|||
|
|
.<span class="ident">metadata</span>(<span class="ident">error_metadata</span>)
|
|||
|
|
.<span class="ident">args</span>(<span class="macro">format_args</span><span class="macro">!</span>(<span class="string">"Error!"</span>))
|
|||
|
|
.<span class="ident">line</span>(<span class="prelude-val">Some</span>(<span class="number">433</span>))
|
|||
|
|
.<span class="ident">file</span>(<span class="prelude-val">Some</span>(<span class="string">"app.rs"</span>))
|
|||
|
|
.<span class="ident">module_path</span>(<span class="prelude-val">Some</span>(<span class="string">"server"</span>))
|
|||
|
|
.<span class="ident">build</span>();</pre>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl<'a> <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#813-893' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#827-837' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Construct new <code>RecordBuilder</code>.</p>
|
|||
|
|
<p>The default options are:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>args</code>: <a href="https://doc.rust-lang.org/std/macro.format_args.html"><code>format_args!("")</code></a></li>
|
|||
|
|
<li><code>metadata</code>: <a href="struct.MetadataBuilder.html#method.build"><code>Metadata::builder().build()</code></a></li>
|
|||
|
|
<li><code>module_path</code>: <code>None</code></li>
|
|||
|
|
<li><code>file</code>: <code>None</code></li>
|
|||
|
|
<li><code>line</code>: <code>None</code></li>
|
|||
|
|
</ul>
|
|||
|
|
</div><h4 id='method.args' class="method"><span id='args.v' class='invisible'><code>pub fn <a href='#method.args' class='fnname'>args</a>(&mut self, args: <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Arguments.html" title="struct core::fmt::Arguments">Arguments</a><'a>) -> &mut <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#841-844' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Set <a href="struct.Record.html#method.args"><code>args</code></a>.</p>
|
|||
|
|
</div><h4 id='method.metadata' class="method"><span id='metadata.v' class='invisible'><code>pub fn <a href='#method.metadata' class='fnname'>metadata</a>(&mut self, metadata: <a class="struct" href="../log/struct.Metadata.html" title="struct log::Metadata">Metadata</a><'a>) -> &mut <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#848-851' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Set <a href="struct.Record.html#method.metadata"><code>metadata</code></a>. Construct a <code>Metadata</code> object with <a href="struct.MetadataBuilder.html"><code>MetadataBuilder</code></a>.</p>
|
|||
|
|
</div><h4 id='method.level' class="method"><span id='level.v' class='invisible'><code>pub fn <a href='#method.level' class='fnname'>level</a>(&mut self, level: <a class="enum" href="../log/enum.Level.html" title="enum log::Level">Level</a>) -> &mut <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#855-858' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Set <a href="struct.Metadata.html#method.level"><code>Metadata::level</code></a>.</p>
|
|||
|
|
</div><h4 id='method.target' class="method"><span id='target.v' class='invisible'><code>pub fn <a href='#method.target' class='fnname'>target</a>(&mut self, target: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> &mut <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#862-865' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Set <a href="struct.Metadata.html#method.target"><code>Metadata::target</code></a></p>
|
|||
|
|
</div><h4 id='method.module_path' class="method"><span id='module_path.v' class='invisible'><code>pub fn <a href='#method.module_path' class='fnname'>module_path</a>(&mut self, path: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>) -> &mut <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#869-872' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Set <a href="struct.Record.html#method.module_path"><code>module_path</code></a></p>
|
|||
|
|
</div><h4 id='method.file' class="method"><span id='file.v' class='invisible'><code>pub fn <a href='#method.file' class='fnname'>file</a>(&mut self, file: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>) -> &mut <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#876-879' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Set <a href="struct.Record.html#method.file"><code>file</code></a></p>
|
|||
|
|
</div><h4 id='method.line' class="method"><span id='line.v' class='invisible'><code>pub fn <a href='#method.line' class='fnname'>line</a>(&mut self, line: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>>) -> &mut <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#883-886' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Set <a href="struct.Record.html#method.line"><code>line</code></a></p>
|
|||
|
|
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><code>pub fn <a href='#method.build' class='fnname'>build</a>(&self) -> <a class="struct" href="../log/struct.Record.html" title="struct log::Record">Record</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#890-892' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Invoke the builder and return a <code>Record</code></p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../log/struct.RecordBuilder.html" title="struct log::RecordBuilder">RecordBuilder</a><'a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#808' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/log/lib.rs.html#808' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></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><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse 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 = "../";
|
|||
|
|
window.currentCrate = "log";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|