github-actions[bot]
33 lines
5.7 KiB
HTML
33 lines
5.7 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="github crates-io docs-rs"><title>unindent - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="unindent" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../unindent/index.html">unindent</a><span class="version">0.2.4</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#unindent" title="Unindent">Unindent</a></li></ul><h3><a href="#traits">Crate Items</a></h3><ul class="block"><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>unindent</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/unindent/lib.rs.html#1-60">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="https://github.com/dtolnay/indoc"><img src="https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github" alt="github" /></a> <a href="https://crates.io/crates/unindent"><img src="https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust" alt="crates-io" /></a> <a href="https://docs.rs/unindent"><img src="https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" alt="docs-rs" /></a></p>
|
||
<br>
|
||
<h3 id="unindent"><a class="doc-anchor" href="#unindent">§</a>Unindent</h3>
|
||
<p>This crate provides <a href="https://github.com/dtolnay/indoc"><code>indoc</code></a>’s indentation logic for use with strings that
|
||
are not statically known at compile time. For unindenting string literals,
|
||
use <code>indoc</code> instead.</p>
|
||
<p>This crate exposes two unindent functions and an extension trait:</p>
|
||
<ul>
|
||
<li><code>fn unindent(&str) -> String</code></li>
|
||
<li><code>fn unindent_bytes(&[u8]) -> Vec<u8></code></li>
|
||
<li><code>trait Unindent</code></li>
|
||
</ul>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>unindent::unindent;
|
||
|
||
<span class="kw">fn </span>main() {
|
||
<span class="kw">let </span>indented = <span class="string">"
|
||
line one
|
||
line two"</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="string">"line one\nline two"</span>, unindent(indented));
|
||
}</code></pre></div>
|
||
<p>The <code>Unindent</code> extension trait expose the same functionality under an
|
||
extension method.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>unindent::Unindent;
|
||
|
||
<span class="kw">fn </span>main() {
|
||
<span class="kw">let </span>indented = <span class="macro">format!</span>(<span class="string">"
|
||
line {}
|
||
line {}"</span>, <span class="string">"one"</span>, <span class="string">"two"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"line one\nline two"</span>, indented.unindent());
|
||
}</code></pre></div>
|
||
</div></details><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Unindent.html" title="trait unindent::Unindent">Unindent</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.unindent.html" title="fn unindent::unindent">unindent</a></div></li><li><div class="item-name"><a class="fn" href="fn.unindent_bytes.html" title="fn unindent::unindent_bytes">unindent_<wbr>bytes</a></div></li></ul></section></div></main></body></html> |