mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 18:32:15 +00:00
38 lines
12 KiB
HTML
38 lines
12 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 `WordSplitter` trait in crate `textwrap`."><meta name="keywords" content="rust, rustlang, rust-lang, WordSplitter"><title>textwrap::WordSplitter - 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 trait"><!--[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><p class='location'>Trait WordSplitter</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.split">split</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>textwrap</a></p><script>window.sidebarCurrent = {name: 'WordSplitter', ty: 'trait', 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/splitting.rs.html#28-45' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>textwrap</a>::<wbr><a class="trait" href=''>WordSplitter</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>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><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>;
|
|||
|
|
}</pre></div><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>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.split' class='method'><code id='split.v'>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><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></h3><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">
|
|||
|
|
<span class="macro">vec</span><span class="macro">!</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>)];</pre></div>
|
|||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-WordSplitter' class='impl'><code class='in-band'>impl WordSplitter for <a class="struct" href="../textwrap/struct.HyphenSplitter.html" title="struct textwrap::HyphenSplitter">HyphenSplitter</a></code><a href='#impl-WordSplitter' class='anchor'></a><a class='srclink' href='../src/textwrap/splitting.rs.html#84-120' title='goto source code'>[src]</a></h3><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><div class='impl-items'><h4 id='method.split' class="method hidden"><code id='split.v-1'>fn <a href='#method.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><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class='srclink' href='../src/textwrap/splitting.rs.html#85-119' title='goto source code'>[src]</a></h4></div><h3 id='impl-WordSplitter-1' class='impl'><code class='in-band'>impl WordSplitter for <a class="struct" href="../textwrap/struct.NoHyphenation.html" title="struct textwrap::NoHyphenation">NoHyphenation</a></code><a href='#impl-WordSplitter-1' class='anchor'></a><a class='srclink' href='../src/textwrap/splitting.rs.html#63-67' title='goto source code'>[src]</a></h3><div class='docblock'><p><code>NoHyphenation</code> implements <code>WordSplitter</code> by not splitting the
|
|||
|
|
word at all.</p>
|
|||
|
|
</div><div class='impl-items'><h4 id='method.split-1' class="method hidden"><code id='split.v-2'>fn <a href='#method.split-1' 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><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class='srclink' href='../src/textwrap/splitting.rs.html#64-66' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../implementors/textwrap/trait.WordSplitter.js">
|
|||
|
|
</script></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>
|