forked from pola-rs/polars
/
index.html
68 lines (63 loc) · 12.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!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="Iterators which split strings on Grapheme Cluster, Word or Sentence boundaries, according to the Unicode Standard Annex #29 rules."><meta name="keywords" content="rust, rustlang, rust-lang, unicode_segmentation"><title>unicode_segmentation - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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" role="button">☰</div><a href='../unicode_segmentation/index.html'><div class='logo-container'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo'></div></a><p class="location">Crate unicode_segmentation</p><div class="block version"><p>Version 1.7.1</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all unicode_segmentation's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="unicode_segmentation" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">unicode_segmentation</a></span><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/unicode_segmentation/lib.rs.html#11-276" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Iterators which split strings on Grapheme Cluster, Word or Sentence boundaries, according
to the <a href="http://www.unicode.org/reports/tr29/">Unicode Standard Annex #29</a> rules.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">unicode_segmentation</span>;
<span class="kw">use</span> <span class="ident">unicode_segmentation</span>::<span class="ident">UnicodeSegmentation</span>;
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="string">"a̐éö̲\r\n"</span>;
<span class="kw">let</span> <span class="ident">g</span> <span class="op">=</span> <span class="ident">UnicodeSegmentation</span>::<span class="ident">graphemes</span>(<span class="ident">s</span>, <span class="bool-val">true</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span><span class="op">></span>();
<span class="kw">let</span> <span class="ident">b</span>: <span class="kw-2">&</span>[<span class="kw">_</span>] <span class="op">=</span> <span class="kw-2">&</span>[<span class="string">"a̐"</span>, <span class="string">"é"</span>, <span class="string">"ö̲"</span>, <span class="string">"\r\n"</span>];
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">g</span>, <span class="ident">b</span>);
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="string">"The quick (\"brown\") fox can't jump 32.3 feet, right?"</span>;
<span class="kw">let</span> <span class="ident">w</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">unicode_words</span>().<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span><span class="op">></span>();
<span class="kw">let</span> <span class="ident">b</span>: <span class="kw-2">&</span>[<span class="kw">_</span>] <span class="op">=</span> <span class="kw-2">&</span>[<span class="string">"The"</span>, <span class="string">"quick"</span>, <span class="string">"brown"</span>, <span class="string">"fox"</span>, <span class="string">"can't"</span>, <span class="string">"jump"</span>, <span class="string">"32.3"</span>, <span class="string">"feet"</span>, <span class="string">"right"</span>];
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">w</span>, <span class="ident">b</span>);
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="string">"The quick (\"brown\") fox"</span>;
<span class="kw">let</span> <span class="ident">w</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">split_word_bounds</span>().<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span><span class="op">></span>();
<span class="kw">let</span> <span class="ident">b</span>: <span class="kw-2">&</span>[<span class="kw">_</span>] <span class="op">=</span> <span class="kw-2">&</span>[<span class="string">"The"</span>, <span class="string">" "</span>, <span class="string">"quick"</span>, <span class="string">" "</span>, <span class="string">"("</span>, <span class="string">"\""</span>, <span class="string">"brown"</span>, <span class="string">"\""</span>, <span class="string">")"</span>, <span class="string">" "</span>, <span class="string">"fox"</span>];
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">w</span>, <span class="ident">b</span>);
}</pre></div>
<h1 id="no_std" class="section-header"><a href="#no_std">no_std</a></h1>
<p>unicode-segmentation does not depend on libstd, so it can be used in crates
with the <code>#![no_std]</code> attribute.</p>
<h1 id="cratesio" class="section-header"><a href="#cratesio">crates.io</a></h1>
<p>You can use this package in your project by adding the following
to your <code>Cargo.toml</code>:</p>
<pre><code class="language-toml">[dependencies]
unicode-segmentation = "1.7.1"
</code></pre>
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.GraphemeCursor.html" title="unicode_segmentation::GraphemeCursor struct">GraphemeCursor</a></td><td class="docblock-short"><p>Cursor-based segmenter for grapheme clusters.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GraphemeIndices.html" title="unicode_segmentation::GraphemeIndices struct">GraphemeIndices</a></td><td class="docblock-short"><p>External iterator for grapheme clusters and byte offsets.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Graphemes.html" title="unicode_segmentation::Graphemes struct">Graphemes</a></td><td class="docblock-short"><p>External iterator for a string’s
<a href="http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries">grapheme clusters</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.USentenceBoundIndices.html" title="unicode_segmentation::USentenceBoundIndices struct">USentenceBoundIndices</a></td><td class="docblock-short"><p>External iterator for sentence boundaries and byte offsets.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.USentenceBounds.html" title="unicode_segmentation::USentenceBounds struct">USentenceBounds</a></td><td class="docblock-short"><p>External iterator for a string’s
<a href="http://www.unicode.org/reports/tr29/#Sentence_Boundaries">sentence boundaries</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UWordBoundIndices.html" title="unicode_segmentation::UWordBoundIndices struct">UWordBoundIndices</a></td><td class="docblock-short"><p>External iterator for word boundaries and byte offsets.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UWordBounds.html" title="unicode_segmentation::UWordBounds struct">UWordBounds</a></td><td class="docblock-short"><p>External iterator for a string’s
<a href="http://www.unicode.org/reports/tr29/#Word_Boundaries">word boundaries</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UnicodeSentences.html" title="unicode_segmentation::UnicodeSentences struct">UnicodeSentences</a></td><td class="docblock-short"><p>An iterator over the substrings of a string which, after splitting the string on
<a href="http://www.unicode.org/reports/tr29/#Sentence_Boundaries">sentence boundaries</a>,
contain any characters with the
<a href="http://unicode.org/reports/tr44/#Alphabetic">Alphabetic</a>
property, or with
<a href="http://unicode.org/reports/tr44/#General_Category_Values">General_Category=Number</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UnicodeWords.html" title="unicode_segmentation::UnicodeWords struct">UnicodeWords</a></td><td class="docblock-short"><p>An iterator over the substrings of a string which, after splitting the string on
<a href="http://www.unicode.org/reports/tr29/#Word_Boundaries">word boundaries</a>,
contain any characters with the
<a href="http://unicode.org/reports/tr44/#Alphabetic">Alphabetic</a>
property, or with
<a href="http://unicode.org/reports/tr44/#General_Category_Values">General_Category=Number</a>.</p>
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<table><tr class="module-item"><td><a class="enum" href="enum.GraphemeIncomplete.html" title="unicode_segmentation::GraphemeIncomplete enum">GraphemeIncomplete</a></td><td class="docblock-short"><p>An error return indicating that not enough content was available in the
provided chunk to satisfy the query, and that more content must be provided.</p>
</td></tr></table><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
<table><tr class="module-item"><td><a class="constant" href="constant.UNICODE_VERSION.html" title="unicode_segmentation::UNICODE_VERSION constant">UNICODE_VERSION</a></td><td class="docblock-short"><p>The version of <a href="http://www.unicode.org/">Unicode</a>
that this version of unicode-segmentation is based on.</p>
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<table><tr class="module-item"><td><a class="trait" href="trait.UnicodeSegmentation.html" title="unicode_segmentation::UnicodeSegmentation trait">UnicodeSegmentation</a></td><td class="docblock-short"><p>Methods for segmenting strings according to
<a href="http://www.unicode.org/reports/tr29/">Unicode Standard Annex #29</a>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="unicode_segmentation" data-search-js="../search-index.js"></div>
<script src="../main.js"></script></body></html>