| <!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="An interface for splitting words."><meta name="keywords" content="rust, rustlang, rust-lang, WordSplitter"><title>WordSplitter 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 trait"><!--[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><h2 class="location"><a href="#">WordSplitter</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.split">split</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><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">Trait <a href="index.html">textwrap</a>::<wbr><a class="trait" href="#">WordSplitter</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/splitting.rs.html#28-45">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 trait"><code>pub trait WordSplitter { |
| fn <a href="#tymethod.split" class="fnname">split</a><'w>(&self, word: &'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><(&'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An interface for splitting words.</p> |
| <p>When the <a href="../struct.Wrapper.html#method.wrap_iter"><code>wrap_iter</code></a> 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 <code>WordSplitter</code> to |
| have it attempt to split the word into smaller parts. This trait |
| describes that functionality via the <a href="#tymethod.split"><code>split</code></a> method.</p> |
| <p>If the <code>textwrap</code> crate has been compiled with the <code>hyphenation</code> |
| feature enabled, you will find an implementation of <code>WordSplitter</code> |
| by the <code>hyphenation::language::Corpus</code> struct. Use this struct for |
| language-aware hyphenation. See the <a href="https://docs.rs/hyphenation/"><code>hyphenation</code> documentation</a> |
| for details.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.split" class="method has-srclink"><a class="srclink rightside" href="../src/textwrap/splitting.rs.html#44">source</a><h4 class="code-header">fn <a href="#tymethod.split" class="fnname">split</a><'w>(&self, word: &'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><(&'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &'w <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)></h4></section></summary><div class="docblock"><p>Return all possible splits of word. Each split is a triple |
| with a head, a hyphen, and a tail where <code>head + &hyphen + &tail == word</code>. The hyphen can be empty if there is already a |
| hyphen in the head.</p> |
| <p>The splits should go from smallest to longest and should |
| include no split at all. So the word “technology” could be |
| split into</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">vec!</span>[(<span class="string">"tech"</span>, <span class="string">"-"</span>, <span class="string">"nology"</span>), |
| (<span class="string">"technol"</span>, <span class="string">"-"</span>, <span class="string">"ogy"</span>), |
| (<span class="string">"technolo"</span>, <span class="string">"-"</span>, <span class="string">"gy"</span>), |
| (<span class="string">"technology"</span>, <span class="string">""</span>, <span class="string">""</span>)];</code></pre></div> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-WordSplitter-for-HyphenSplitter" class="impl has-srclink"><a class="srclink rightside" href="../src/textwrap/splitting.rs.html#84-120">source</a><a href="#impl-WordSplitter-for-HyphenSplitter" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.WordSplitter.html" title="trait textwrap::WordSplitter">WordSplitter</a> for <a class="struct" href="struct.HyphenSplitter.html" title="struct textwrap::HyphenSplitter">HyphenSplitter</a></h3></section><div class="docblock"><p><code>HyphenSplitter</code> is the default <code>WordSplitter</code> used by |
| <code>Wrapper::new</code>. It will split words on any existing hyphens in the |
| word.</p> |
| <p>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.</p> |
| </div><section id="impl-WordSplitter-for-NoHyphenation" class="impl has-srclink"><a class="srclink rightside" href="../src/textwrap/splitting.rs.html#63-67">source</a><a href="#impl-WordSplitter-for-NoHyphenation" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.WordSplitter.html" title="trait textwrap::WordSplitter">WordSplitter</a> for <a class="struct" href="struct.NoHyphenation.html" title="struct textwrap::NoHyphenation">NoHyphenation</a></h3></section><div class="docblock"><p><code>NoHyphenation</code> implements <code>WordSplitter</code> by not splitting the |
| word at all.</p> |
| </div></div><script src="../implementors/textwrap/splitting/trait.WordSplitter.js" async></script></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> |
