api-docs/crates-app/src/textwrap/splitting.rs.html - incubator-teaclave-website - Git at Google

 <!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/textwrap-0.11.0/src/splitting.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>splitting.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="../../textwrap/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="../../textwrap/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>
 <span id="114">114</span>
 <span id="115">115</span>
 <span id="116">116</span>
 <span id="117">117</span>
 <span id="118">118</span>
 <span id="119">119</span>
 <span id="120">120</span>
 <span id="121">121</span>
 <span id="122">122</span>
 <span id="123">123</span>
 <span id="124">124</span>
 <span id="125">125</span>
 <span id="126">126</span>
 <span id="127">127</span>
 <span id="128">128</span>
 <span id="129">129</span>
 <span id="130">130</span>
 <span id="131">131</span>
 <span id="132">132</span>
 <span id="133">133</span>
 <span id="134">134</span>
 <span id="135">135</span>
 <span id="136">136</span>
 <span id="137">137</span>
 <span id="138">138</span>
 <span id="139">139</span>
 </pre><pre class="rust"><code><span class="doccomment">//! Word splitting functionality.
 //!
 //! To wrap text into lines, long words sometimes need to be split
 //! across lines. The [`WordSplitter`] trait defines this
 //! functionality. [`HyphenSplitter`] is the default implementation of
 //! this treat: it will simply split words on existing hyphens.

 </span><span class="attribute">#[cfg(feature = <span class="string">&quot;hyphenation&quot;</span>)]
 </span><span class="kw">use </span>hyphenation::{Hyphenator, Standard};

 <span class="doccomment">/// An interface for splitting words.
 ///
 /// When the [`wrap_iter`] method will try to fit text into a line, it
 /// will eventually find a word that it too large the current text
 /// width. It will then call the currently configured `WordSplitter` to
 /// have it attempt to split the word into smaller parts. This trait
 /// describes that functionality via the [`split`] method.
 ///
 /// If the `textwrap` crate has been compiled with the `hyphenation`
 /// feature enabled, you will find an implementation of `WordSplitter`
 /// by the `hyphenation::language::Corpus` struct. Use this struct for
 /// language-aware hyphenation. See the [`hyphenation` documentation]
 /// for details.
 ///
 /// [`wrap_iter`]: ../struct.Wrapper.html#method.wrap_iter
 /// [`split`]: #tymethod.split
 /// [`hyphenation` documentation]: https://docs.rs/hyphenation/
 </span><span class="kw">pub trait </span>WordSplitter {
     <span class="doccomment">/// Return all possible splits of word. Each split is a triple
     /// with a head, a hyphen, and a tail where `head + &amp;hyphen +
     /// &amp;tail == word`. The hyphen can be empty if there is already a
     /// hyphen in the head.
     ///
     /// The splits should go from smallest to longest and should
     /// include no split at all. So the word &quot;technology&quot; could be
     /// split into
     ///
     /// ```no_run
     /// vec![(&quot;tech&quot;, &quot;-&quot;, &quot;nology&quot;),
     ///      (&quot;technol&quot;, &quot;-&quot;, &quot;ogy&quot;),
     ///      (&quot;technolo&quot;, &quot;-&quot;, &quot;gy&quot;),
     ///      (&quot;technology&quot;, &quot;&quot;, &quot;&quot;)];
     /// ```
     </span><span class="kw">fn </span>split&lt;<span class="lifetime">&#39;w</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, word: <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str) -&gt; Vec&lt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str)&gt;;
 }

 <span class="doccomment">/// Use this as a [`Wrapper.splitter`] to avoid any kind of
 /// hyphenation:
 ///
 /// ```
 /// use textwrap::{Wrapper, NoHyphenation};
 ///
 /// let wrapper = Wrapper::with_splitter(8, NoHyphenation);
 /// assert_eq!(wrapper.wrap(&quot;foo bar-baz&quot;), vec![&quot;foo&quot;, &quot;bar-baz&quot;]);
 /// ```
 ///
 /// [`Wrapper.splitter`]: ../struct.Wrapper.html#structfield.splitter
 </span><span class="attribute">#[derive(Clone, Debug)]
 </span><span class="kw">pub struct </span>NoHyphenation;

 <span class="doccomment">/// `NoHyphenation` implements `WordSplitter` by not splitting the
 /// word at all.
 </span><span class="kw">impl </span>WordSplitter <span class="kw">for </span>NoHyphenation {
     <span class="kw">fn </span>split&lt;<span class="lifetime">&#39;w</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, word: <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str) -&gt; Vec&lt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str)&gt; {
         <span class="macro">vec!</span>[(word, <span class="string">&quot;&quot;</span>, <span class="string">&quot;&quot;</span>)]
     }
 }

 <span class="doccomment">/// Simple and default way to split words: splitting on existing
 /// hyphens only.
 ///
 /// You probably don&#39;t need to use this type since it&#39;s already used
 /// by default by `Wrapper::new`.
 </span><span class="attribute">#[derive(Clone, Debug)]
 </span><span class="kw">pub struct </span>HyphenSplitter;

 <span class="doccomment">/// `HyphenSplitter` is the default `WordSplitter` used by
 /// `Wrapper::new`. It will split words on any existing hyphens in the
 /// word.
 ///
 /// It will only use hyphens that are surrounded by alphanumeric
 /// characters, which prevents a word like &quot;--foo-bar&quot; from being
 /// split on the first or second hyphen.
 </span><span class="kw">impl </span>WordSplitter <span class="kw">for </span>HyphenSplitter {
     <span class="kw">fn </span>split&lt;<span class="lifetime">&#39;w</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, word: <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str) -&gt; Vec&lt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str)&gt; {
         <span class="kw">let </span><span class="kw-2">mut </span>triples = Vec::new();
         <span class="comment">// Split on hyphens, smallest split first. We only use hyphens
         // that are surrounded by alphanumeric characters. This is to
         // avoid splitting on repeated hyphens, such as those found in
         // --foo-bar.
         </span><span class="kw">let </span><span class="kw-2">mut </span>char_indices = word.char_indices();
         <span class="comment">// Early return if the word is empty.
         </span><span class="kw">let </span><span class="kw-2">mut </span>prev = <span class="kw">match </span>char_indices.next() {
             <span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="macro">vec!</span>[(word, <span class="string">&quot;&quot;</span>, <span class="string">&quot;&quot;</span>)],
             <span class="prelude-val">Some</span>((<span class="kw">_</span>, ch)) =&gt; ch,
         };

         <span class="comment">// Find current word, or return early if the word only has a
         // single character.
         </span><span class="kw">let </span>(<span class="kw-2">mut </span>idx, <span class="kw-2">mut </span>cur) = <span class="kw">match </span>char_indices.next() {
             <span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="macro">vec!</span>[(word, <span class="string">&quot;&quot;</span>, <span class="string">&quot;&quot;</span>)],
             <span class="prelude-val">Some</span>((idx, cur)) =&gt; (idx, cur),
         };

         <span class="kw">for </span>(i, next) <span class="kw">in </span>char_indices {
             <span class="kw">if </span>prev.is_alphanumeric() &amp;&amp; cur == <span class="string">&#39;-&#39; </span>&amp;&amp; next.is_alphanumeric() {
                 <span class="kw">let </span>(head, tail) = word.split_at(idx + <span class="number">1</span>);
                 triples.push((head, <span class="string">&quot;&quot;</span>, tail));
             }
             prev = cur;
             idx = i;
             cur = next;
         }

         <span class="comment">// Finally option is no split at all.
         </span>triples.push((word, <span class="string">&quot;&quot;</span>, <span class="string">&quot;&quot;</span>));

         triples
     }
 }

 <span class="doccomment">/// A hyphenation dictionary can be used to do language-specific
 /// hyphenation using patterns from the hyphenation crate.
 </span><span class="attribute">#[cfg(feature = <span class="string">&quot;hyphenation&quot;</span>)]
 </span><span class="kw">impl </span>WordSplitter <span class="kw">for </span>Standard {
     <span class="kw">fn </span>split&lt;<span class="lifetime">&#39;w</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, word: <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str) -&gt; Vec&lt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;w </span>str)&gt; {
         <span class="comment">// Find splits based on language dictionary.
         </span><span class="kw">let </span><span class="kw-2">mut </span>triples = Vec::new();
         <span class="kw">for </span>n <span class="kw">in </span><span class="self">self</span>.hyphenate(word).breaks {
             <span class="kw">let </span>(head, tail) = word.split_at(n);
             <span class="kw">let </span>hyphen = <span class="kw">if </span>head.ends_with(<span class="string">&#39;-&#39;</span>) { <span class="string">&quot;&quot; </span>} <span class="kw">else </span>{ <span class="string">&quot;-&quot; </span>};
             triples.push((head, hyphen, tail));
         }
         <span class="comment">// Finally option is no split at all.
         </span>triples.push((word, <span class="string">&quot;&quot;</span>, <span class="string">&quot;&quot;</span>));

         triples
     }
 }
 </code></pre></div>
 </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>
	<!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/textwrap-0.11.0/src/splitting.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>splitting.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="../../textwrap/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="../../textwrap/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>
	<span id="114">114</span>
	<span id="115">115</span>
	<span id="116">116</span>
	<span id="117">117</span>
	<span id="118">118</span>
	<span id="119">119</span>
	<span id="120">120</span>
	<span id="121">121</span>
	<span id="122">122</span>
	<span id="123">123</span>
	<span id="124">124</span>
	<span id="125">125</span>
	<span id="126">126</span>
	<span id="127">127</span>
	<span id="128">128</span>
	<span id="129">129</span>
	<span id="130">130</span>
	<span id="131">131</span>
	<span id="132">132</span>
	<span id="133">133</span>
	<span id="134">134</span>
	<span id="135">135</span>
	<span id="136">136</span>
	<span id="137">137</span>
	<span id="138">138</span>
	<span id="139">139</span>
	</pre><pre class="rust"><code><span class="doccomment">//! Word splitting functionality.
	//!
	//! To wrap text into lines, long words sometimes need to be split
	//! across lines. The [`WordSplitter`] trait defines this
	//! functionality. [`HyphenSplitter`] is the default implementation of
	//! this treat: it will simply split words on existing hyphens.

	</span><span class="attribute">#[cfg(feature = <span class="string">"hyphenation"</span>)]
	</span><span class="kw">use </span>hyphenation::{Hyphenator, Standard};

	<span class="doccomment">/// An interface for splitting words.
	///
	/// When the [`wrap_iter`] method will try to fit text into a line, it
	/// will eventually find a word that it too large the current text
	/// width. It will then call the currently configured `WordSplitter` to
	/// have it attempt to split the word into smaller parts. This trait
	/// describes that functionality via the [`split`] method.
	///
	/// If the `textwrap` crate has been compiled with the `hyphenation`
	/// feature enabled, you will find an implementation of `WordSplitter`
	/// by the `hyphenation::language::Corpus` struct. Use this struct for
	/// language-aware hyphenation. See the [`hyphenation` documentation]
	/// for details.
	///
	/// [`wrap_iter`]: ../struct.Wrapper.html#method.wrap_iter
	/// [`split`]: #tymethod.split
	/// [`hyphenation` documentation]: https://docs.rs/hyphenation/
	</span><span class="kw">pub trait </span>WordSplitter {
	<span class="doccomment">/// Return all possible splits of word. Each split is a triple
	/// with a head, a hyphen, and a tail where `head + &hyphen +
	/// &tail == word`. The hyphen can be empty if there is already a
	/// hyphen in the head.
	///
	/// The splits should go from smallest to longest and should
	/// include no split at all. So the word "technology" could be
	/// split into
	///
	/// ```no_run
	/// vec![("tech", "-", "nology"),
	/// ("technol", "-", "ogy"),
	/// ("technolo", "-", "gy"),
	/// ("technology", "", "")];
	/// ```
	</span><span class="kw">fn </span>split<<span class="lifetime">'w</span>>(<span class="kw-2">&</span><span class="self">self</span>, word: <span class="kw-2">&</span><span class="lifetime">'w </span>str) -> Vec<(<span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str)>;
	}

	<span class="doccomment">/// Use this as a [`Wrapper.splitter`] to avoid any kind of
	/// hyphenation:
	///
	/// ```
	/// use textwrap::{Wrapper, NoHyphenation};
	///
	/// let wrapper = Wrapper::with_splitter(8, NoHyphenation);
	/// assert_eq!(wrapper.wrap("foo bar-baz"), vec!["foo", "bar-baz"]);
	/// ```
	///
	/// [`Wrapper.splitter`]: ../struct.Wrapper.html#structfield.splitter
	</span><span class="attribute">#[derive(Clone, Debug)]
	</span><span class="kw">pub struct </span>NoHyphenation;

	<span class="doccomment">/// `NoHyphenation` implements `WordSplitter` by not splitting the
	/// word at all.
	</span><span class="kw">impl </span>WordSplitter <span class="kw">for </span>NoHyphenation {
	<span class="kw">fn </span>split<<span class="lifetime">'w</span>>(<span class="kw-2">&</span><span class="self">self</span>, word: <span class="kw-2">&</span><span class="lifetime">'w </span>str) -> Vec<(<span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str)> {
	<span class="macro">vec!</span>[(word, <span class="string">""</span>, <span class="string">""</span>)]
	}
	}

	<span class="doccomment">/// Simple and default way to split words: splitting on existing
	/// hyphens only.
	///
	/// You probably don't need to use this type since it's already used
	/// by default by `Wrapper::new`.
	</span><span class="attribute">#[derive(Clone, Debug)]
	</span><span class="kw">pub struct </span>HyphenSplitter;

	<span class="doccomment">/// `HyphenSplitter` is the default `WordSplitter` used by
	/// `Wrapper::new`. It will split words on any existing hyphens in the
	/// word.
	///
	/// It will only use hyphens that are surrounded by alphanumeric
	/// characters, which prevents a word like "--foo-bar" from being
	/// split on the first or second hyphen.
	</span><span class="kw">impl </span>WordSplitter <span class="kw">for </span>HyphenSplitter {
	<span class="kw">fn </span>split<<span class="lifetime">'w</span>>(<span class="kw-2">&</span><span class="self">self</span>, word: <span class="kw-2">&</span><span class="lifetime">'w </span>str) -> Vec<(<span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str)> {
	<span class="kw">let </span><span class="kw-2">mut </span>triples = Vec::new();
	<span class="comment">// Split on hyphens, smallest split first. We only use hyphens
	// that are surrounded by alphanumeric characters. This is to
	// avoid splitting on repeated hyphens, such as those found in
	// --foo-bar.
	</span><span class="kw">let </span><span class="kw-2">mut </span>char_indices = word.char_indices();
	<span class="comment">// Early return if the word is empty.
	</span><span class="kw">let </span><span class="kw-2">mut </span>prev = <span class="kw">match </span>char_indices.next() {
	<span class="prelude-val">None </span>=> <span class="kw">return </span><span class="macro">vec!</span>[(word, <span class="string">""</span>, <span class="string">""</span>)],
	<span class="prelude-val">Some</span>((<span class="kw">_</span>, ch)) => ch,
	};

	<span class="comment">// Find current word, or return early if the word only has a
	// single character.
	</span><span class="kw">let </span>(<span class="kw-2">mut </span>idx, <span class="kw-2">mut </span>cur) = <span class="kw">match </span>char_indices.next() {
	<span class="prelude-val">None </span>=> <span class="kw">return </span><span class="macro">vec!</span>[(word, <span class="string">""</span>, <span class="string">""</span>)],
	<span class="prelude-val">Some</span>((idx, cur)) => (idx, cur),
	};

	<span class="kw">for </span>(i, next) <span class="kw">in </span>char_indices {
	<span class="kw">if </span>prev.is_alphanumeric() && cur == <span class="string">'-' </span>&& next.is_alphanumeric() {
	<span class="kw">let </span>(head, tail) = word.split_at(idx + <span class="number">1</span>);
	triples.push((head, <span class="string">""</span>, tail));
	}
	prev = cur;
	idx = i;
	cur = next;
	}

	<span class="comment">// Finally option is no split at all.
	</span>triples.push((word, <span class="string">""</span>, <span class="string">""</span>));

	triples
	}
	}

	<span class="doccomment">/// A hyphenation dictionary can be used to do language-specific
	/// hyphenation using patterns from the hyphenation crate.
	</span><span class="attribute">#[cfg(feature = <span class="string">"hyphenation"</span>)]
	</span><span class="kw">impl </span>WordSplitter <span class="kw">for </span>Standard {
	<span class="kw">fn </span>split<<span class="lifetime">'w</span>>(<span class="kw-2">&</span><span class="self">self</span>, word: <span class="kw-2">&</span><span class="lifetime">'w </span>str) -> Vec<(<span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str, <span class="kw-2">&</span><span class="lifetime">'w </span>str)> {
	<span class="comment">// Find splits based on language dictionary.
	</span><span class="kw">let </span><span class="kw-2">mut </span>triples = Vec::new();
	<span class="kw">for </span>n <span class="kw">in </span><span class="self">self</span>.hyphenate(word).breaks {
	<span class="kw">let </span>(head, tail) = word.split_at(n);
	<span class="kw">let </span>hyphen = <span class="kw">if </span>head.ends_with(<span class="string">'-'</span>) { <span class="string">"" </span>} <span class="kw">else </span>{ <span class="string">"-" </span>};
	triples.push((head, hyphen, tail));
	}
	<span class="comment">// Finally option is no split at all.
	</span>triples.push((word, <span class="string">""</span>, <span class="string">""</span>));

	triples
	}
	}
	</code></pre></div>
	</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>