blob: d0613610614acbff0ccde910bc6565f3d1befab1 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/itertools-0.8.2/src/format.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>format.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../itertools/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../itertools/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::cell::RefCell;
<span class="doccomment">/// Format all iterator elements lazily, separated by `sep`.
///
/// The format value can only be formatted once, after that the iterator is
/// exhausted.
///
/// See [`.format_with()`](../trait.Itertools.html#method.format_with) for more information.
</span><span class="kw">pub struct </span>FormatWith&lt;<span class="lifetime">&#39;a</span>, I, F&gt; {
sep: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// FormatWith uses interior mutability because Display::fmt takes &amp;self.
</span>inner: RefCell&lt;<span class="prelude-ty">Option</span>&lt;(I, F)&gt;&gt;,
}
<span class="doccomment">/// Format all iterator elements lazily, separated by `sep`.
///
/// The format value can only be formatted once, after that the iterator is
/// exhausted.
///
/// See [`.format()`](../trait.Itertools.html#method.format)
/// for more information.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>Format&lt;<span class="lifetime">&#39;a</span>, I&gt; {
sep: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// Format uses interior mutability because Display::fmt takes &amp;self.
</span>inner: RefCell&lt;<span class="prelude-ty">Option</span>&lt;I&gt;&gt;,
}
<span class="kw">pub fn </span>new_format&lt;<span class="lifetime">&#39;a</span>, I, F&gt;(iter: I, separator: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str, f: F) -&gt; FormatWith&lt;<span class="lifetime">&#39;a</span>, I, F&gt;
<span class="kw">where </span>I: Iterator,
F: FnMut(I::Item, <span class="kw-2">&amp;mut </span>FnMut(<span class="kw-2">&amp;</span>fmt::Display) -&gt; fmt::Result) -&gt; fmt::Result
{
FormatWith {
sep: separator,
inner: RefCell::new(<span class="prelude-val">Some</span>((iter, f))),
}
}
<span class="kw">pub fn </span>new_format_default&lt;<span class="lifetime">&#39;a</span>, I&gt;(iter: I, separator: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str) -&gt; Format&lt;<span class="lifetime">&#39;a</span>, I&gt;
<span class="kw">where </span>I: Iterator,
{
Format {
sep: separator,
inner: RefCell::new(<span class="prelude-val">Some</span>(iter)),
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, I, F&gt; fmt::Display <span class="kw">for </span>FormatWith&lt;<span class="lifetime">&#39;a</span>, I, F&gt;
<span class="kw">where </span>I: Iterator,
F: FnMut(I::Item, <span class="kw-2">&amp;mut </span>FnMut(<span class="kw-2">&amp;</span>fmt::Display) -&gt; fmt::Result) -&gt; fmt::Result
{
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">let </span>(<span class="kw-2">mut </span>iter, <span class="kw-2">mut </span>format) = <span class="kw">match </span><span class="self">self</span>.inner.borrow_mut().take() {
<span class="prelude-val">Some</span>(t) =&gt; t,
<span class="prelude-val">None </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;FormatWith: was already formatted once&quot;</span>),
};
<span class="kw">if let </span><span class="prelude-val">Some</span>(fst) = iter.next() {
<span class="macro">try!</span>(format(fst, <span class="kw-2">&amp;mut </span>|disp: <span class="kw-2">&amp;</span>fmt::Display| disp.fmt(f)));
<span class="kw">for </span>elt <span class="kw">in </span>iter {
<span class="kw">if </span><span class="self">self</span>.sep.len() &gt; <span class="number">0 </span>{
<span class="macro">try!</span>(f.write_str(<span class="self">self</span>.sep));
}
<span class="macro">try!</span>(format(elt, <span class="kw-2">&amp;mut </span>|disp: <span class="kw-2">&amp;</span>fmt::Display| disp.fmt(f)));
}
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, I&gt; Format&lt;<span class="lifetime">&#39;a</span>, I&gt;
<span class="kw">where </span>I: Iterator,
{
<span class="kw">fn </span>format&lt;F&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter, <span class="kw-2">mut </span>cb: F) -&gt; fmt::Result
<span class="kw">where </span>F: FnMut(<span class="kw-2">&amp;</span>I::Item, <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result,
{
<span class="kw">let </span><span class="kw-2">mut </span>iter = <span class="kw">match </span><span class="self">self</span>.inner.borrow_mut().take() {
<span class="prelude-val">Some</span>(t) =&gt; t,
<span class="prelude-val">None </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;Format: was already formatted once&quot;</span>),
};
<span class="kw">if let </span><span class="prelude-val">Some</span>(fst) = iter.next() {
<span class="macro">try!</span>(cb(<span class="kw-2">&amp;</span>fst, f));
<span class="kw">for </span>elt <span class="kw">in </span>iter {
<span class="kw">if </span><span class="self">self</span>.sep.len() &gt; <span class="number">0 </span>{
<span class="macro">try!</span>(f.write_str(<span class="self">self</span>.sep));
}
<span class="macro">try!</span>(cb(<span class="kw-2">&amp;</span>elt, f));
}
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="macro">macro_rules! </span>impl_format {
($(<span class="macro-nonterminal">$fmt_trait</span>:ident)<span class="kw-2">*</span>) =&gt; {
$(
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, I&gt; fmt::<span class="macro-nonterminal">$fmt_trait </span><span class="kw">for </span>Format&lt;<span class="lifetime">&#39;a</span>, I&gt;
<span class="kw">where </span>I: Iterator,
I::Item: fmt::<span class="macro-nonterminal">$fmt_trait</span>,
{
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="self">self</span>.format(f, fmt::<span class="macro-nonterminal">$fmt_trait::fmt</span>)
}
}
)*
}
}
<span class="macro">impl_format!</span>{Display Debug
UpperExp LowerExp UpperHex LowerHex Octal Binary Pointer}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="itertools" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>