| <!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="Lazily wrap a line of text at `width` characters. Strings are wrapped based on their displayed width, not their size in bytes."><meta name="keywords" content="rust, rustlang, rust-lang, wrap_iter"><title>wrap_iter in textwrap - Rust</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="sidebar-items.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 fn"><!--[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><a class="sidebar-logo" href="../textwrap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../textwrap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2><a href="index.html">In textwrap</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Function <a href="index.html">textwrap</a>::<wbr><a class="fn" href="#">wrap_iter</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/textwrap/lib.rs.html#698-700">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust fn"><code>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="struct.IntoWrapIter.html" title="struct textwrap::IntoWrapIter">IntoWrapIter</a><'_, <a class="struct" href="struct.HyphenSplitter.html" title="struct textwrap::HyphenSplitter">HyphenSplitter</a>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.IntoWrapIter.html" title="struct textwrap::IntoWrapIter">IntoWrapIter</a><'a, S></span><code class="content"><span class="where fmt-newline">impl<'a, S: <a class="trait" href="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="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="associatedtype">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></span></span></span></span></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::borrow::Cow; |
| <span class="kw">use </span>textwrap::wrap_iter; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>wrap20_iter = wrap_iter(<span class="string">"Zero-cost abstractions."</span>, <span class="number">20</span>); |
| <span class="macro">assert_eq!</span>(wrap20_iter.next(), <span class="prelude-val">Some</span>(Cow::from(<span class="string">"Zero-cost"</span>))); |
| <span class="macro">assert_eq!</span>(wrap20_iter.next(), <span class="prelude-val">Some</span>(Cow::from(<span class="string">"abstractions."</span>))); |
| <span class="macro">assert_eq!</span>(wrap20_iter.next(), <span class="prelude-val">None</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>wrap25_iter = wrap_iter(<span class="string">"Zero-cost abstractions."</span>, <span class="number">25</span>); |
| <span class="macro">assert_eq!</span>(wrap25_iter.next(), <span class="prelude-val">Some</span>(Cow::from(<span class="string">"Zero-cost abstractions."</span>))); |
| <span class="macro">assert_eq!</span>(wrap25_iter.next(), <span class="prelude-val">None</span>);</code></pre></div> |
| </div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="textwrap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
