mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
72 lines
9.1 KiB
HTML
72 lines
9.1 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="A few wrappers for the `fmt::Write` objects that efficiently appends and remove common indentation after every newline"><title>indenter - Rust</title><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"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="indenter" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.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 crate"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../indenter/index.html">indenter</a><span class="version">0.3.3</span></h2></div><div class="sidebar-elems"><ul class="block">
|
||
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section></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="../indenter/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>Crate <a class="mod" href="#">indenter</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/indenter/lib.rs.html#1-542">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A few wrappers for the <code>fmt::Write</code> objects that efficiently appends and remove
|
||
common indentation after every newline</p>
|
||
<h2 id="setup"><a href="#setup">Setup</a></h2>
|
||
<p>Add this to your <code>Cargo.toml</code>:</p>
|
||
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
|
||
indenter = "0.2"
|
||
</code></pre></div><h2 id="examples"><a href="#examples">Examples</a></h2><h3 id="indentation-only"><a href="#indentation-only">Indentation only</a></h3>
|
||
<p>This type is intended primarily for writing error reporters that gracefully
|
||
format error messages that span multiple lines.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::error::Error;
|
||
<span class="kw">use </span>core::fmt::{<span class="self">self</span>, Write};
|
||
<span class="kw">use </span>indenter::indented;
|
||
|
||
<span class="kw">struct </span>ErrorReporter<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw">dyn </span>Error);
|
||
|
||
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ErrorReporter<<span class="lifetime">'_</span>> {
|
||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>source = <span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="number">0</span>);
|
||
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
|
||
|
||
<span class="kw">while let </span><span class="prelude-val">Some</span>(error) = source {
|
||
<span class="macro">writeln!</span>(f)<span class="question-mark">?</span>;
|
||
<span class="macro">write!</span>(indented(f).ind(i), <span class="string">"{}"</span>, error)<span class="question-mark">?</span>;
|
||
|
||
source = error.source();
|
||
i += <span class="number">1</span>;
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(())
|
||
}
|
||
}</code></pre></div>
|
||
<h3 id="dedenting-removing-common-leading-indendation"><a href="#dedenting-removing-common-leading-indendation">“Dedenting” (removing common leading indendation)</a></h3>
|
||
<p>This type is intended primarily for formatting source code. For example, when
|
||
generating code.</p>
|
||
<p>This type requires the feature <code>std</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::error::Error;
|
||
<span class="kw">use </span>core::fmt::{<span class="self">self</span>, Write};
|
||
<span class="kw">use </span>indenter::CodeFormatter;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>output = String::new();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>f = CodeFormatter::new(<span class="kw-2">&mut </span>output, <span class="string">" "</span>);
|
||
|
||
<span class="macro">write!</span>(
|
||
f,
|
||
<span class="string">r#"
|
||
Hello
|
||
World
|
||
"#</span>,
|
||
);
|
||
|
||
<span class="macro">assert_eq!</span>(output, <span class="string">"Hello\n World\n"</span>);
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>output = String::new();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>f = CodeFormatter::new(<span class="kw-2">&mut </span>output, <span class="string">" "</span>);
|
||
|
||
<span class="comment">// it can also indent...
|
||
</span>f.indent(<span class="number">2</span>);
|
||
|
||
<span class="macro">write!</span>(
|
||
f,
|
||
<span class="string">r#"
|
||
Hello
|
||
World
|
||
"#</span>,
|
||
);
|
||
|
||
<span class="macro">assert_eq!</span>(output, <span class="string">" Hello\n World\n"</span>);</code></pre></div>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Indented.html" title="struct indenter::Indented">Indented</a></div><div class="desc docblock-short">Helper struct for efficiently indenting multi line display implementations</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Format.html" title="enum indenter::Format">Format</a></div><div class="desc docblock-short">The set of supported formats for indentation</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.indented.html" title="fn indenter::indented">indented</a></div><div class="desc docblock-short">Helper function for creating a default indenter</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Inserter.html" title="type indenter::Inserter">Inserter</a></div><div class="desc docblock-short">A callback for <code>Format::Custom</code> used to insert indenation after a new line</div></li></ul></section></div></main></body></html> |