| <!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="Cursor-based segmenter for grapheme clusters."><meta name="keywords" content="rust, rustlang, rust-lang, GraphemeCursor"><title>GraphemeCursor in unicode_segmentation - 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="icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"></head><body class="rustdoc struct"><!--[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="../unicode_segmentation/index.html"><div class="logo-container"><img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../unicode_segmentation/index.html"><div class="logo-container"> |
| <img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></div></a><h2 class="location"><a href="#">GraphemeCursor</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.cur_cursor">cur_cursor</a></li><li><a href="#method.is_boundary">is_boundary</a></li><li><a href="#method.new">new</a></li><li><a href="#method.next_boundary">next_boundary</a></li><li><a href="#method.prev_boundary">prev_boundary</a></li><li><a href="#method.provide_context">provide_context</a></li><li><a href="#method.set_cursor">set_cursor</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-GraphemeCursor">Clone</a></li><li><a href="#impl-Debug-for-GraphemeCursor">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-GraphemeCursor">RefUnwindSafe</a></li><li><a href="#impl-Send-for-GraphemeCursor">Send</a></li><li><a href="#impl-Sync-for-GraphemeCursor">Sync</a></li><li><a href="#impl-Unpin-for-GraphemeCursor">Unpin</a></li><li><a href="#impl-UnwindSafe-for-GraphemeCursor">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-GraphemeCursor">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-GraphemeCursor">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-GraphemeCursor">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-GraphemeCursor">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-GraphemeCursor">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-GraphemeCursor">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-GraphemeCursor">TryInto<U></a></li></ul></section><h2><a href="index.html">In unicode_segmentation</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">Struct <a href="index.html">unicode_segmentation</a>::<wbr><a class="struct" href="#">GraphemeCursor</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/unicode_segmentation/grapheme.rs.html#183-209">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 struct"><code>pub struct GraphemeCursor { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Cursor-based segmenter for grapheme clusters.</p> |
| <p>This allows working with ropes and other datastructures where the string is not contiguous or |
| fully known at initialization time.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#277-755">source</a><a href="#impl-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#292-310">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, is_extended: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a>) -> <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h4></section></summary><div class="docblock"><p>Create a new cursor. The string and initial offset are given at creation |
| time, but the contents of the string are not. The <code>is_extended</code> parameter |
| controls whether extended grapheme clusters are selected.</p> |
| <p>The <code>offset</code> parameter must be on a codepoint boundary.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"हिन्दी"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>legacy = GraphemeCursor::new(<span class="number">0</span>, s.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(legacy.next_boundary(s, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="string">"ह"</span>.len()))); |
| <span class="kw">let </span><span class="kw-2">mut </span>extended = GraphemeCursor::new(<span class="number">0</span>, s.len(), <span class="bool-val">true</span>); |
| <span class="macro">assert_eq!</span>(extended.next_boundary(s, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="string">"हि"</span>.len())));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_cursor" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#352-365">source</a><h4 class="code-header">pub fn <a href="#method.set_cursor" class="fnname">set_cursor</a>(&mut self, offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Set the cursor to a new location in the same string.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"abcd"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">0</span>, s.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(cursor.cur_cursor(), <span class="number">0</span>); |
| cursor.set_cursor(<span class="number">2</span>); |
| <span class="macro">assert_eq!</span>(cursor.cur_cursor(), <span class="number">2</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cur_cursor" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#381-383">source</a><h4 class="code-header">pub fn <a href="#method.cur_cursor" class="fnname">cur_cursor</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>The current offset of the cursor. Equal to the last value provided to |
| <code>new()</code> or <code>set_cursor()</code>, or returned from <code>next_boundary()</code> or |
| <code>prev_boundary()</code>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Two flags (🇷🇸🇮🇴), each flag is two RIS codepoints, each RIS is 4 bytes. |
| </span><span class="kw">let </span>flags = <span class="string">"\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">4</span>, flags.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(cursor.cur_cursor(), <span class="number">4</span>); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">8</span>))); |
| <span class="macro">assert_eq!</span>(cursor.cur_cursor(), <span class="number">8</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.provide_context" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#404-425">source</a><h4 class="code-header">pub fn <a href="#method.provide_context" class="fnname">provide_context</a>(&mut self, chunk: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>, chunk_start: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Provide additional pre-context when it is needed to decide a boundary. |
| The end of the chunk must coincide with the value given in the |
| <code>GraphemeIncomplete::PreContext</code> request.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>flags = <span class="string">"\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">8</span>, flags.len(), <span class="bool-val">false</span>); |
| <span class="comment">// Not enough pre-context to decide if there's a boundary between the two flags. |
| </span><span class="macro">assert_eq!</span>(cursor.is_boundary(<span class="kw-2">&</span>flags[<span class="number">8</span>..], <span class="number">8</span>), <span class="prelude-val">Err</span>(GraphemeIncomplete::PreContext(<span class="number">8</span>))); |
| <span class="comment">// Provide one more Regional Indicator Symbol of pre-context |
| </span>cursor.provide_context(<span class="kw-2">&</span>flags[<span class="number">4</span>..<span class="number">8</span>], <span class="number">4</span>); |
| <span class="comment">// Still not enough context to decide. |
| </span><span class="macro">assert_eq!</span>(cursor.is_boundary(<span class="kw-2">&</span>flags[<span class="number">8</span>..], <span class="number">8</span>), <span class="prelude-val">Err</span>(GraphemeIncomplete::PreContext(<span class="number">4</span>))); |
| <span class="comment">// Provide additional requested context. |
| </span>cursor.provide_context(<span class="kw-2">&</span>flags[<span class="number">0</span>..<span class="number">4</span>], <span class="number">0</span>); |
| <span class="comment">// That's enough to decide (it always is when context goes to the start of the string) |
| </span><span class="macro">assert_eq!</span>(cursor.is_boundary(<span class="kw-2">&</span>flags[<span class="number">8</span>..], <span class="number">8</span>), <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_boundary" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#531-591">source</a><h4 class="code-header">pub fn <a href="#method.is_boundary" class="fnname">is_boundary</a>(<br> &mut self,<br> chunk: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>,<br> chunk_start: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a>, <a class="enum" href="enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a>></h4></section></summary><div class="docblock"><p>Determine whether the current cursor location is a grapheme cluster boundary. |
| Only a part of the string need be supplied. If <code>chunk_start</code> is nonzero or |
| the length of <code>chunk</code> is not equal to <code>len</code> on creation, then this method |
| may return <code>GraphemeIncomplete::PreContext</code>. The caller should then |
| call <code>provide_context</code> with the requested chunk, then retry calling this |
| method.</p> |
| <p>For partial chunks, if the cursor is not at the beginning or end of the |
| string, the chunk should contain at least the codepoint following the cursor. |
| If the string is nonempty, the chunk must be nonempty.</p> |
| <p>All calls should have consistent chunk contents (ie, if a chunk provides |
| content for a given slice, all further chunks covering that slice must have |
| the same content for it).</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>flags = <span class="string">"\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">8</span>, flags.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(cursor.is_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>)); |
| cursor.set_cursor(<span class="number">12</span>); |
| <span class="macro">assert_eq!</span>(cursor.is_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.next_boundary" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#626-670">source</a><h4 class="code-header">pub fn <a href="#method.next_boundary" class="fnname">next_boundary</a>(<br> &mut self,<br> chunk: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>,<br> chunk_start: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>>, <a class="enum" href="enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a>></h4></section></summary><div class="docblock"><p>Find the next boundary after the current cursor position. Only a part of |
| the string need be supplied. If the chunk is incomplete, then this |
| method might return <code>GraphemeIncomplete::PreContext</code> or |
| <code>GraphemeIncomplete::NextChunk</code>. In the former case, the caller should |
| call <code>provide_context</code> with the requested chunk, then retry. In the |
| latter case, the caller should provide the chunk following the one |
| given, then retry.</p> |
| <p>See <code>is_boundary</code> for expectations on the provided chunk.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>flags = <span class="string">"\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">4</span>, flags.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">8</span>))); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">16</span>))); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>));</code></pre></div> |
| <p>And an example that uses partial strings:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"abcd"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">0</span>, s.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(<span class="kw-2">&</span>s[..<span class="number">2</span>], <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">1</span>))); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(<span class="kw-2">&</span>s[..<span class="number">2</span>], <span class="number">0</span>), <span class="prelude-val">Err</span>(GraphemeIncomplete::NextChunk)); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(<span class="kw-2">&</span>s[<span class="number">2</span>..<span class="number">4</span>], <span class="number">2</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">2</span>))); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(<span class="kw-2">&</span>s[<span class="number">2</span>..<span class="number">4</span>], <span class="number">2</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">3</span>))); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(<span class="kw-2">&</span>s[<span class="number">2</span>..<span class="number">4</span>], <span class="number">2</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">4</span>))); |
| <span class="macro">assert_eq!</span>(cursor.next_boundary(<span class="kw-2">&</span>s[<span class="number">2</span>..<span class="number">4</span>], <span class="number">2</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.prev_boundary" class="method has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#705-754">source</a><h4 class="code-header">pub fn <a href="#method.prev_boundary" class="fnname">prev_boundary</a>(<br> &mut self,<br> chunk: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>,<br> chunk_start: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>>, <a class="enum" href="enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a>></h4></section></summary><div class="docblock"><p>Find the previous boundary after the current cursor position. Only a part |
| of the string need be supplied. If the chunk is incomplete, then this |
| method might return <code>GraphemeIncomplete::PreContext</code> or |
| <code>GraphemeIncomplete::PrevChunk</code>. In the former case, the caller should |
| call <code>provide_context</code> with the requested chunk, then retry. In the |
| latter case, the caller should provide the chunk preceding the one |
| given, then retry.</p> |
| <p>See <code>is_boundary</code> for expectations on the provided chunk.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>flags = <span class="string">"\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">12</span>, flags.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">8</span>))); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">0</span>))); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(flags, <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>));</code></pre></div> |
| <p>And an example that uses partial strings (note the exact return is not |
| guaranteed, and may be <code>PrevChunk</code> or <code>PreContext</code> arbitrarily):</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = <span class="string">"abcd"</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>cursor = GraphemeCursor::new(<span class="number">4</span>, s.len(), <span class="bool-val">false</span>); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(<span class="kw-2">&</span>s[<span class="number">2</span>..<span class="number">4</span>], <span class="number">2</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">3</span>))); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(<span class="kw-2">&</span>s[<span class="number">2</span>..<span class="number">4</span>], <span class="number">2</span>), <span class="prelude-val">Err</span>(GraphemeIncomplete::PrevChunk)); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(<span class="kw-2">&</span>s[<span class="number">0</span>..<span class="number">2</span>], <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">2</span>))); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(<span class="kw-2">&</span>s[<span class="number">0</span>..<span class="number">2</span>], <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">1</span>))); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(<span class="kw-2">&</span>s[<span class="number">0</span>..<span class="number">2</span>], <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">0</span>))); |
| <span class="macro">assert_eq!</span>(cursor.prev_boundary(<span class="kw-2">&</span>s[<span class="number">0</span>..<span class="number">2</span>], <span class="number">0</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>));</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#182">source</a><a href="#impl-Clone-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#182">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#182">source</a><a href="#impl-Debug-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/unicode_segmentation/grapheme.rs.html#182">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-GraphemeCursor" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section><section id="impl-Send-for-GraphemeCursor" class="impl has-srclink"><a href="#impl-Send-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section><section id="impl-Sync-for-GraphemeCursor" class="impl has-srclink"><a href="#impl-Sync-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section><section id="impl-Unpin-for-GraphemeCursor" class="impl has-srclink"><a href="#impl-Unpin-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section><section id="impl-UnwindSafe-for-GraphemeCursor" class="impl has-srclink"><a href="#impl-UnwindSafe-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.GraphemeCursor.html" title="struct unicode_segmentation::GraphemeCursor">GraphemeCursor</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-GraphemeCursor" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-GraphemeCursor" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="unicode_segmentation" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
