mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 10:22:19 +00:00
23 lines
8.8 KiB
HTML
23 lines
8.8 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 `wrap_iter` fn in crate `textwrap`."><meta name="keywords" content="rust, rustlang, rust-lang, wrap_iter"><title>textwrap::wrap_iter - 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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='../textwrap/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>textwrap</a></p><script>window.sidebarCurrent = {name: 'wrap_iter', ty: 'fn', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/textwrap/lib.rs.html#698-700' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>textwrap</a>::<wbr><a class="fn" href=''>wrap_iter</a></span></h1><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../textwrap/struct.IntoWrapIter.html" title="struct textwrap::IntoWrapIter">IntoWrapIter</a><'a, S></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../textwrap/struct.IntoWrapIter.html" title="struct textwrap::IntoWrapIter">IntoWrapIter</a><'a, S></h3><code class="content"><span class="where fmt-newline">impl<'a, S: <a class="trait" href="../textwrap/trait.WordSplitter.html" title="trait textwrap::WordSplitter">WordSplitter</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../textwrap/struct.IntoWrapIter.html" title="struct textwrap::IntoWrapIter">IntoWrapIter</a><'a, S></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>;</span></code></div></div><pre class='rust fn'>pub fn wrap_iter(s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../textwrap/struct.IntoWrapIter.html" title="struct textwrap::IntoWrapIter">IntoWrapIter</a><<a class="struct" href="../textwrap/struct.HyphenSplitter.html" title="struct textwrap::HyphenSplitter">HyphenSplitter</a>></pre><div class='docblock'><p>Lazily wrap a line of text at <code>width</code> characters. Strings are
|
||
wrapped based on their displayed width, not their size in bytes.</p>
|
||
<p>This function creates a Wrapper on the fly with default settings.
|
||
It then calls the <a href="struct.Wrapper.html#method.into_wrap_iter"><code>into_wrap_iter</code></a> method. Hence, the return
|
||
value is an <a href="struct.IntoWrapIter.html"><code>IntoWrapIter</code></a>, not a <a href="struct.WrapIter.html"><code>WrapIter</code></a> as the function
|
||
name would otherwise suggest.</p>
|
||
<p>If you need to set a language corpus for automatic hyphenation, or
|
||
need to wrap many strings, then it is suggested to create a Wrapper
|
||
and call its <a href="struct.Wrapper.html#method.wrap_iter"><code>wrap_iter</code></a> or <a href="struct.Wrapper.html#method.into_wrap_iter"><code>into_wrap_iter</code></a> methods.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">borrow</span>::<span class="ident">Cow</span>;
|
||
<span class="kw">use</span> <span class="ident">textwrap</span>::<span class="ident">wrap_iter</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">wrap20_iter</span> <span class="op">=</span> <span class="ident">wrap_iter</span>(<span class="string">"Zero-cost abstractions."</span>, <span class="number">20</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">wrap20_iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="ident">Cow</span>::<span class="ident">from</span>(<span class="string">"Zero-cost"</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">wrap20_iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="ident">Cow</span>::<span class="ident">from</span>(<span class="string">"abstractions."</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">wrap20_iter</span>.<span class="ident">next</span>(), <span class="prelude-val">None</span>);
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">wrap25_iter</span> <span class="op">=</span> <span class="ident">wrap_iter</span>(<span class="string">"Zero-cost abstractions."</span>, <span class="number">25</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">wrap25_iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="ident">Cow</span>::<span class="ident">from</span>(<span class="string">"Zero-cost abstractions."</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">wrap25_iter</span>.<span class="ident">next</span>(), <span class="prelude-val">None</span>);</pre></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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "textwrap";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |