hasufell
/
pnmixer-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
pnmixer-rust/utf8_ranges/enum.Utf8Sequence.html

161 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `Utf8Sequence` enum in crate `utf8_ranges`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Utf8Sequence">
<title>utf8_ranges::Utf8Sequence - 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">
</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">
<p class='location'>Enum Utf8Sequence</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>utf8_ranges</a></p><script>window.sidebarCurrent = {name: 'Utf8Sequence', 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'>utf8_ranges</a>::<wbr><a class="enum" href=''>Utf8Sequence</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/utf8_ranges/lib.rs.html#112-121' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Utf8Sequence {
One(<a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a>),
Two(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>),
Three(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>),
Four(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 4]</a>),
}</pre><div class='docblock'><p>Utf8Sequence represents a sequence of byte ranges.</p>
<p>To match a Utf8Sequence, a candidate byte sequence must match each
successive range.</p>
<p>For example, if there are two ranges, <code>[C2-DF][80-BF]</code>, then the byte
sequence <code>\xDD\x61</code> would not match because <code>0x61 &lt; 0x80</code>.</p>
</div><h2 id='variants' class='variants'>Variants</h2>
<span id='variant.One' class='variant'><span id='One.v' class='invisible'><code>One(<a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a>)</code></span></span><div class='docblock'><p>One byte range.</p>
</div><span id='variant.Two' class='variant'><span id='Two.v' class='invisible'><code>Two(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>)</code></span></span><div class='docblock'><p>Two successive byte ranges.</p>
</div><span id='variant.Three' class='variant'><span id='Three.v' class='invisible'><code>Three(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>)</code></span></span><div class='docblock'><p>Three successive byte ranges.</p>
</div><span id='variant.Four' class='variant'><span id='Four.v' class='invisible'><code>Four(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 4]</a>)</code></span></span><div class='docblock'><p>Four successive byte ranges.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="enum" href="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/utf8_ranges/lib.rs.html#123-181' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.as_slice' class="method"><span id='as_slice.v' class='invisible'><code>fn <a href='#method.as_slice' class='fnname'>as_slice</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></h4>
<div class='docblock'><p>Returns the underlying sequence of byte ranges as a slice.</p>
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>fn <a href='#method.len' class='fnname'>len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
<div class='docblock'><p>Returns the number of byte ranges in this sequence.</p>
<p>The length is guaranteed to be in the closed interval <code>[1, 4]</code>.</p>
</div><h4 id='method.matches' class="method"><span id='matches.v' class='invisible'><code>fn <a href='#method.matches' class='fnname'>matches</a>(&amp;self, bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>Returns true if and only if a prefix of <code>bytes</code> matches this sequence
of byte ranges.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/utf8_ranges/lib.rs.html#111' 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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/utf8_ranges/lib.rs.html#111' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>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></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="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/utf8_ranges/lib.rs.html#111' 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/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/utf8_ranges/lib.rs.html#111' 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="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></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="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for &amp;'a <a class="enum" href="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/utf8_ranges/lib.rs.html#183-190' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.IntoIter' class="type"><span id='IntoIter.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/core/slice/struct.Iter.html" title="struct core::slice::Iter">Iter</a>&lt;'a, <a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a>&gt;</code></span></h4>
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
</div><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = &amp;'a <a class="struct" href="../utf8_ranges/struct.Utf8Range.html" title="struct utf8_ranges::Utf8Range">Utf8Range</a></code></span></h4>
<div class='docblock'><p>The type of the elements being iterated over.</p>
</div><h4 id='method.into_iter' class="method"><span id='into_iter.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -&gt; Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a></code></span></h4>
<div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
</div></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="../utf8_ranges/enum.Utf8Sequence.html" title="enum utf8_ranges::Utf8Sequence">Utf8Sequence</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/utf8_ranges/lib.rs.html#192-203' 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, f: &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></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 = "utf8_ranges";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink