blob: c41493684dea238959b92c369c13841aff4cfcaa [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="API documentation for the Rust `GraphemeIncomplete` enum in crate `unicode_segmentation`.">
<meta name="keywords" content="rust, rustlang, rust-lang, GraphemeIncomplete">
<title>unicode_segmentation::GraphemeIncomplete - Rust</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 enum">
<!--[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>
<p class='location'>Enum GraphemeIncomplete</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>unicode_segmentation</a></p><script>window.sidebarCurrent = {name: 'GraphemeIncomplete', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</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">
<h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>unicode_segmentation</a>::<wbr><a class="enum" href=''>GraphemeIncomplete</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/unicode_segmentation/grapheme.rs.html#186-205' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum GraphemeIncomplete {
PreContext(usize),
PrevChunk,
NextChunk,
InvalidOffset,
}</pre><div class='docblock'><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>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id='variant.PreContext' class='variant'><span id='PreContext.v' class='invisible'><code>PreContext(usize)</code></span></span><div class='docblock'><p>More pre-context is needed. The caller should call <code>provide_context</code>
with a chunk ending at the offset given, then retry the query. This
will only be returned if the <code>chunk_start</code> parameter is nonzero.</p>
</div><span id='variant.PrevChunk' class='variant'><span id='PrevChunk.v' class='invisible'><code>PrevChunk</code></span></span><div class='docblock'><p>When requesting <code>prev_boundary</code>, the cursor is moving past the beginning
of the current chunk, so the chunk before that is requested. This will
only be returned if the <code>chunk_start</code> parameter is nonzero.</p>
</div><span id='variant.NextChunk' class='variant'><span id='NextChunk.v' class='invisible'><code>NextChunk</code></span></span><div class='docblock'><p>When requesting <code>next_boundary</code>, the cursor is moving past the end of the
current chunk, so the chunk after that is requested. This will only be
returned if the chunk ends before the <code>len</code> parameter provided on
creation of the cursor.</p>
</div><span id='variant.InvalidOffset' class='variant'><span id='InvalidOffset.v' class='invisible'><code>InvalidOffset</code></span></span><div class='docblock'><p>An error returned when the chunk given does not contain the cursor position.</p>
</div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../unicode_segmentation/enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_segmentation/grapheme.rs.html#185' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../unicode_segmentation/enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a>) -&gt; bool</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_segmentation/grapheme.rs.html#185' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../unicode_segmentation/enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a>) -&gt; bool</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_segmentation/grapheme.rs.html#185' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../unicode_segmentation/enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_segmentation/grapheme.rs.html#185' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>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="enum" href="../unicode_segmentation/enum.GraphemeIncomplete.html" title="enum unicode_segmentation::GraphemeIncomplete">GraphemeIncomplete</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_segmentation/grapheme.rs.html#185' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_segmentation/grapheme.rs.html#185' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div></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>