mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-14 03:58:23 +00:00
37 lines
6.9 KiB
HTML
37 lines
6.9 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="Prints to `stdout`, with a newline."><title>println in anstream - 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="anstream" 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 macro"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../anstream/index.html">anstream</a><span class="version">0.6.14</span></h2></div><div class="sidebar-elems"></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="../anstream/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>Macro <a href="index.html">anstream</a>::<wbr><a class="macro" href="#">println</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/anstream/macros.rs.html#139-169">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> println {
|
||
() => { ... };
|
||
($(<span class="macro-nonterminal">$arg</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Prints to <a href="fn.stdout.html" title="fn anstream::stdout"><code>stdout</code></a>, with a newline.</p>
|
||
<p>On all platforms, the newline is the LINE FEED character (<code>\n</code>/<code>U+000A</code>) alone
|
||
(no additional CARRIAGE RETURN (<code>\r</code>/<code>U+000D</code>)).</p>
|
||
<p>This macro uses the same syntax as <a href="https://doc.rust-lang.org/1.78.0/alloc/macro.format.html" title="macro alloc::format"><code>format!</code></a>, but writes to the standard output instead.
|
||
See <a href="https://doc.rust-lang.org/1.78.0/alloc/fmt/index.html" title="mod alloc::fmt"><code>std::fmt</code></a> for more information.</p>
|
||
<p><strong>NOTE:</strong> The <code>println!</code> macro will lock the standard output on each call. If you call
|
||
<code>println!</code> within a hot loop, this behavior may be the bottleneck of the loop.
|
||
To avoid this, lock stdout with <a href="struct.AutoStream.html#method.lock" title="method anstream::AutoStream::lock"><code>AutoStream::lock</code></a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::Write <span class="kw">as _</span>;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>lock = anstream::stdout().lock();
|
||
<span class="macro">writeln!</span>(lock, <span class="string">"hello world"</span>).unwrap();</code></pre></div>
|
||
<p>Use <code>println!</code> only for the primary output of your program. Use
|
||
<a href="https://doc.rust-lang.org/1.78.0/std/macro.eprintln.html" title="macro std::eprintln"><code>eprintln!</code></a> instead to print error and progress messages.</p>
|
||
<p><strong>NOTE:</strong> Not all <code>println!</code> calls will be captured in tests like <a href="https://doc.rust-lang.org/1.78.0/std/macro.println.html" title="macro std::println"><code>std::println!</code></a></p>
|
||
<ul>
|
||
<li>Capturing will automatically be activated in test binaries</li>
|
||
<li>Otherwise, only when the <code>test</code> feature is enabled</li>
|
||
</ul>
|
||
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||
<p>Panics if writing to <code>stdout</code> fails for any reason <strong>except</strong> broken pipe.</p>
|
||
<p>Writing to non-blocking stdout can cause an error, which will lead
|
||
this macro to panic.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>anstream::println;
|
||
|
||
<span class="macro">println!</span>(); <span class="comment">// prints just a newline
|
||
</span><span class="macro">println!</span>(<span class="string">"hello there!"</span>);
|
||
<span class="macro">println!</span>(<span class="string">"format {} arguments"</span>, <span class="string">"some"</span>);
|
||
<span class="kw">let </span>local_variable = <span class="string">"some"</span>;
|
||
<span class="macro">println!</span>(<span class="string">"format {local_variable} arguments"</span>);</code></pre></div>
|
||
</div></details></section></div></main></body></html> |