mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-20 18:20:41 +00:00
170 lines
17 KiB
HTML
170 lines
17 KiB
HTML
<!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 `Node` struct in crate `fst`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Node">
|
||
|
||
<title>fst::raw::Node - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
||
<script src="../../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'>Struct Node</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.transitions">transitions</a><a href="#method.transition">transition</a><a href="#method.transition_addr">transition_addr</a><a href="#method.find_input">find_input</a><a href="#method.final_output">final_output</a><a href="#method.is_final">is_final</a><a href="#method.len">len</a><a href="#method.is_empty">is_empty</a><a href="#method.addr">addr</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>fst</a>::<wbr><a href='index.html'>raw</a></p><script>window.sidebarCurrent = {name: 'Node', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../../theme.js"></script>
|
||
<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'>Struct <a href='../index.html'>fst</a>::<wbr><a href='index.html'>raw</a>::<wbr><a class="struct" href=''>Node</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/fst/raw/node.rs.html#17-26' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Node<'f> { /* fields omitted */ }</pre><div class='docblock'><p>Node represents a single state in a finite state transducer.</p>
|
||
<p>Nodes are very cheap to construct. Notably, they satisfy the <code>Copy</code> trait.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl<'f> <a class="struct" href="../../fst/raw/struct.Node.html" title="struct fst::raw::Node">Node</a><'f></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#112-250' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.transitions' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../fst/raw/struct.Transitions.html" title="struct fst::raw::Transitions">Transitions</a><'f, 'n></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../fst/raw/struct.Transitions.html" title="struct fst::raw::Transitions">Transitions</a><'f, 'n></h3><code class="content"><span class="where fmt-newline">impl<'f, 'n> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../fst/raw/struct.Transitions.html" title="struct fst::raw::Transitions">Transitions</a><'f, 'n></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="struct" href="../../fst/raw/struct.Transition.html" title="struct fst::raw::Transition">Transition</a>;</span></code></div></div><span id='transitions.v' class='invisible'><code>pub fn <a href='#method.transitions' class='fnname'>transitions</a><'n>(&'n self) -> <a class="struct" href="../../fst/raw/struct.Transitions.html" title="struct fst::raw::Transitions">Transitions</a><'f, 'n></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#115-117' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns an iterator over all transitions in this node in lexicographic
|
||
order.</p>
|
||
</div><h4 id='method.transition' class="method"><span id='transition.v' class='invisible'><code>pub fn <a href='#method.transition' class='fnname'>transition</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../fst/raw/struct.Transition.html" title="struct fst::raw::Transition">Transition</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#120-148' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the transition at index <code>i</code>.</p>
|
||
</div><h4 id='method.transition_addr' class="method"><span id='transition_addr.v' class='invisible'><code>pub fn <a href='#method.transition_addr' class='fnname'>transition_addr</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="../../fst/raw/type.CompiledAddr.html" title="type fst::raw::CompiledAddr">CompiledAddr</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#151-165' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the transition address of the <code>i</code>th transition.</p>
|
||
</div><h4 id='method.find_input' class="method"><span id='find_input.v' class='invisible'><code>pub fn <a href='#method.find_input' class='fnname'>find_input</a>(&self, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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/std/primitive.usize.html">usize</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#170-180' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Finds the <code>i</code>th transition corresponding to the given input byte.</p>
|
||
<p>If no transition for this byte exists, then <code>None</code> is returned.</p>
|
||
</div><h4 id='method.final_output' class="method"><span id='final_output.v' class='invisible'><code>pub fn <a href='#method.final_output' class='fnname'>final_output</a>(&self) -> <a class="struct" href="../../fst/raw/struct.Output.html" title="struct fst::raw::Output">Output</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#184-186' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>If this node is final and has a terminal output value, then it is
|
||
returned. Otherwise, a zero output is returned.</p>
|
||
</div><h4 id='method.is_final' class="method"><span id='is_final.v' class='invisible'><code>pub fn <a href='#method.is_final' class='fnname'>is_final</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#190-192' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns true if and only if this node corresponds to a final or "match"
|
||
state in the finite state transducer.</p>
|
||
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>pub fn <a href='#method.len' class='fnname'>len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#197-199' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the number of transitions in this node.</p>
|
||
<p>The maximum number of transitions is 256.</p>
|
||
</div><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#202-204' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns true if and only if this node has zero transitions.</p>
|
||
</div><h4 id='method.addr' class="method"><span id='addr.v' class='invisible'><code>pub fn <a href='#method.addr' class='fnname'>addr</a>(&self) -> <a class="type" href="../../fst/raw/type.CompiledAddr.html" title="type fst::raw::CompiledAddr">CompiledAddr</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#207-209' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return the address of this node.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<'f> <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="../../fst/raw/struct.Node.html" title="struct fst::raw::Node">Node</a><'f></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#16' 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>(&self) -> <a class="struct" href="../../fst/raw/struct.Node.html" title="struct fst::raw::Node">Node</a><'f></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#16' title='goto source code'>[src]</a></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>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></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 id='impl-Copy' class='impl'><span class='in-band'><code>impl<'f> <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="struct" href="../../fst/raw/struct.Node.html" title="struct fst::raw::Node">Node</a><'f></code><a href='#impl-Copy' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#16' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<'f> <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="../../fst/raw/struct.Node.html" title="struct fst::raw::Node">Node</a><'f></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#28-43' 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>(&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></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/raw/node.rs.html#29-42' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>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></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><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse 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 = "fst";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |