blob: 43c70a55d1cac99d6faa4ff59a016be410830a45 [file] [log] [blame]
<!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 to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-segmentation-1.2.0/src/lib.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>lib.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../../unicode_segmentation/index.html'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo' width='100'></a>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="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>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license</span>
<span class="comment">// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="doccomment">//! Iterators which split strings on Grapheme Cluster or Word boundaries, according</span>
<span class="doccomment">//! to the [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/) rules.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! extern crate unicode_segmentation;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! use unicode_segmentation::UnicodeSegmentation;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! fn main() {</span>
<span class="doccomment">//! let s = &quot;a̐éö̲\r\n&quot;;</span>
<span class="doccomment">//! let g = UnicodeSegmentation::graphemes(s, true).collect::&lt;Vec&lt;&amp;str&gt;&gt;();</span>
<span class="doccomment">//! let b: &amp;[_] = &amp;[&quot;a̐&quot;, &quot;é&quot;, &quot;ö̲&quot;, &quot;\r\n&quot;];</span>
<span class="doccomment">//! assert_eq!(g, b);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let s = &quot;The quick (\&quot;brown\&quot;) fox can&#39;t jump 32.3 feet, right?&quot;;</span>
<span class="doccomment">//! let w = s.unicode_words().collect::&lt;Vec&lt;&amp;str&gt;&gt;();</span>
<span class="doccomment">//! let b: &amp;[_] = &amp;[&quot;The&quot;, &quot;quick&quot;, &quot;brown&quot;, &quot;fox&quot;, &quot;can&#39;t&quot;, &quot;jump&quot;, &quot;32.3&quot;, &quot;feet&quot;, &quot;right&quot;];</span>
<span class="doccomment">//! assert_eq!(w, b);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let s = &quot;The quick (\&quot;brown\&quot;) fox&quot;;</span>
<span class="doccomment">//! let w = s.split_word_bounds().collect::&lt;Vec&lt;&amp;str&gt;&gt;();</span>
<span class="doccomment">//! let b: &amp;[_] = &amp;[&quot;The&quot;, &quot; &quot;, &quot;quick&quot;, &quot; &quot;, &quot;(&quot;, &quot;\&quot;&quot;, &quot;brown&quot;, &quot;\&quot;&quot;, &quot;)&quot;, &quot; &quot;, &quot; &quot;, &quot;fox&quot;];</span>
<span class="doccomment">//! assert_eq!(w, b);</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # no_std</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! unicode-segmentation does not depend on libstd, so it can be used in crates</span>
<span class="doccomment">//! with the `#![no_std]` attribute.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # crates.io</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! You can use this package in your project by adding the following</span>
<span class="doccomment">//! to your `Cargo.toml`:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```toml</span>
<span class="doccomment">//! [dependencies]</span>
<span class="doccomment">//! unicode-segmentation = &quot;1.1.0&quot;</span>
<span class="doccomment">//! ```</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">deny</span>(<span class="ident">missing_docs</span>, <span class="ident">unsafe_code</span>)]</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">doc</span>(<span class="ident">html_logo_url</span> <span class="op">=</span> <span class="string">&quot;https://unicode-rs.github.io/unicode-rs_sm.png&quot;</span>,
<span class="ident">html_favicon_url</span> <span class="op">=</span> <span class="string">&quot;https://unicode-rs.github.io/unicode-rs_sm.png&quot;</span>)]</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">no_std</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">std</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">quickcheck</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">grapheme</span>::{<span class="ident">Graphemes</span>, <span class="ident">GraphemeIndices</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">grapheme</span>::{<span class="ident">GraphemeCursor</span>, <span class="ident">GraphemeIncomplete</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">tables</span>::<span class="ident">UNICODE_VERSION</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">word</span>::{<span class="ident">UWordBounds</span>, <span class="ident">UWordBoundIndices</span>, <span class="ident">UnicodeWords</span>};
<span class="kw">mod</span> <span class="ident">grapheme</span>;
<span class="kw">mod</span> <span class="ident">tables</span>;
<span class="kw">mod</span> <span class="ident">word</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">test</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">testdata</span>;
<span class="doccomment">/// Methods for segmenting strings according to</span>
<span class="doccomment">/// [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/).</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">UnicodeSegmentation</span> {
<span class="doccomment">/// Returns an iterator over the [grapheme clusters][graphemes] of `self`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [graphemes]: http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If `is_extended` is true, the iterator is over the</span>
<span class="doccomment">/// *extended grapheme clusters*;</span>
<span class="doccomment">/// otherwise, the iterator is over the *legacy grapheme clusters*.</span>
<span class="doccomment">/// [UAX#29](http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries)</span>
<span class="doccomment">/// recommends extended grapheme cluster boundaries for general processing.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use self::unicode_segmentation::UnicodeSegmentation;</span>
<span class="doccomment">/// let gr1 = UnicodeSegmentation::graphemes(&quot;a\u{310}e\u{301}o\u{308}\u{332}&quot;, true)</span>
<span class="doccomment">/// .collect::&lt;Vec&lt;&amp;str&gt;&gt;();</span>
<span class="doccomment">/// let b: &amp;[_] = &amp;[&quot;a\u{310}&quot;, &quot;e\u{301}&quot;, &quot;o\u{308}\u{332}&quot;];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(&amp;gr1[..], b);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let gr2 = UnicodeSegmentation::graphemes(&quot;a\r\nb🇷🇺🇸🇹&quot;, true).collect::&lt;Vec&lt;&amp;str&gt;&gt;();</span>
<span class="doccomment">/// let b: &amp;[_] = &amp;[&quot;a&quot;, &quot;\r\n&quot;, &quot;b&quot;, &quot;🇷🇺&quot;, &quot;🇸🇹&quot;];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(&amp;gr2[..], b);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">graphemes</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="self">self</span>, <span class="ident">is_extended</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">Graphemes</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>;
<span class="doccomment">/// Returns an iterator over the grapheme clusters of `self` and their</span>
<span class="doccomment">/// byte offsets. See `graphemes()` for more information.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use self::unicode_segmentation::UnicodeSegmentation;</span>
<span class="doccomment">/// let gr_inds = UnicodeSegmentation::grapheme_indices(&quot;a̐éö̲\r\n&quot;, true)</span>
<span class="doccomment">/// .collect::&lt;Vec&lt;(usize, &amp;str)&gt;&gt;();</span>
<span class="doccomment">/// let b: &amp;[_] = &amp;[(0, &quot;a̐&quot;), (3, &quot;é&quot;), (6, &quot;ö̲&quot;), (11, &quot;\r\n&quot;)];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(&amp;gr_inds[..], b);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">grapheme_indices</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="self">self</span>, <span class="ident">is_extended</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">GraphemeIndices</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>;
<span class="doccomment">/// Returns an iterator over the words of `self`, separated on</span>
<span class="doccomment">/// [UAX#29 word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Here, &quot;words&quot; are just those substrings which, after splitting on</span>
<span class="doccomment">/// UAX#29 word boundaries, contain any alphanumeric characters. That is, the</span>
<span class="doccomment">/// substring must contain at least one character with the</span>
<span class="doccomment">/// [Alphabetic](http://unicode.org/reports/tr44/#Alphabetic)</span>
<span class="doccomment">/// property, or with</span>
<span class="doccomment">/// [General_Category=Number](http://unicode.org/reports/tr44/#General_Category_Values).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use self::unicode_segmentation::UnicodeSegmentation;</span>
<span class="doccomment">/// let uws = &quot;The quick (\&quot;brown\&quot;) fox can&#39;t jump 32.3 feet, right?&quot;;</span>
<span class="doccomment">/// let uw1 = uws.unicode_words().collect::&lt;Vec&lt;&amp;str&gt;&gt;();</span>
<span class="doccomment">/// let b: &amp;[_] = &amp;[&quot;The&quot;, &quot;quick&quot;, &quot;brown&quot;, &quot;fox&quot;, &quot;can&#39;t&quot;, &quot;jump&quot;, &quot;32.3&quot;, &quot;feet&quot;, &quot;right&quot;];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(&amp;uw1[..], b);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">unicode_words</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">UnicodeWords</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>;
<span class="doccomment">/// Returns an iterator over substrings of `self` separated on</span>
<span class="doccomment">/// [UAX#29 word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The concatenation of the substrings returned by this function is just the original string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use self::unicode_segmentation::UnicodeSegmentation;</span>
<span class="doccomment">/// let swu1 = &quot;The quick (\&quot;brown\&quot;) fox&quot;.split_word_bounds().collect::&lt;Vec&lt;&amp;str&gt;&gt;();</span>
<span class="doccomment">/// let b: &amp;[_] = &amp;[&quot;The&quot;, &quot; &quot;, &quot;quick&quot;, &quot; &quot;, &quot;(&quot;, &quot;\&quot;&quot;, &quot;brown&quot;, &quot;\&quot;&quot;, &quot;)&quot;, &quot; &quot;, &quot; &quot;, &quot;fox&quot;];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(&amp;swu1[..], b);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">split_word_bounds</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">UWordBounds</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>;
<span class="doccomment">/// Returns an iterator over substrings of `self`, split on UAX#29 word boundaries,</span>
<span class="doccomment">/// and their offsets. See `split_word_bounds()` for more information.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use self::unicode_segmentation::UnicodeSegmentation;</span>
<span class="doccomment">/// let swi1 = &quot;Brr, it&#39;s 29.3°F!&quot;.split_word_bound_indices().collect::&lt;Vec&lt;(usize, &amp;str)&gt;&gt;();</span>
<span class="doccomment">/// let b: &amp;[_] = &amp;[(0, &quot;Brr&quot;), (3, &quot;,&quot;), (4, &quot; &quot;), (5, &quot;it&#39;s&quot;), (9, &quot; &quot;), (10, &quot;29.3&quot;),</span>
<span class="doccomment">/// (14, &quot;°&quot;), (16, &quot;F&quot;), (17, &quot;!&quot;)];</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(&amp;swi1[..], b);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">split_word_bound_indices</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">UWordBoundIndices</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>;
}
<span class="kw">impl</span> <span class="ident">UnicodeSegmentation</span> <span class="kw">for</span> <span class="ident">str</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">graphemes</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">is_extended</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">Graphemes</span> {
<span class="ident">grapheme</span>::<span class="ident">new_graphemes</span>(<span class="self">self</span>, <span class="ident">is_extended</span>)
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">grapheme_indices</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">is_extended</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="ident">GraphemeIndices</span> {
<span class="ident">grapheme</span>::<span class="ident">new_grapheme_indices</span>(<span class="self">self</span>, <span class="ident">is_extended</span>)
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">unicode_words</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">UnicodeWords</span> {
<span class="ident">word</span>::<span class="ident">new_unicode_words</span>(<span class="self">self</span>)
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">split_word_bounds</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">UWordBounds</span> {
<span class="ident">word</span>::<span class="ident">new_word_bounds</span>(<span class="self">self</span>)
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">split_word_bound_indices</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">UWordBoundIndices</span> {
<span class="ident">word</span>::<span class="ident">new_word_bound_indices</span>(<span class="self">self</span>)
}
}
</pre>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "unicode_segmentation";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>