mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-20 10:10:42 +00:00
153 lines
14 KiB
HTML
153 lines
14 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 `Intersection` struct in crate `fst`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Intersection">
|
||
|
||
<title>fst::automaton::Intersection - 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 Intersection</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Automaton">Automaton</a></div></div><p class='location'><a href='../index.html'>fst</a>::<wbr><a href='index.html'>automaton</a></p><script>window.sidebarCurrent = {name: 'Intersection', 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'>automaton</a>::<wbr><a class="struct" href=''>Intersection</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/automaton/mod.rs.html#243' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Intersection<A, B>(_, _);</pre><div class='docblock'><p>An automaton that matches when both of its component automata match.</p>
|
||
</div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Automaton' class='impl'><span class='in-band'><code>impl<A: <a class="trait" href="../../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a>, B: <a class="trait" href="../../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a>> <a class="trait" href="../../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a> for <a class="struct" href="../../fst/automaton/struct.Intersection.html" title="struct fst::automaton::Intersection">Intersection</a><A, B></code><a href='#impl-Automaton' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/automaton/mod.rs.html#248-280' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.State' class="type"><span id='State.t' class='invisible'><code>type <a href='../../fst/automaton/trait.Automaton.html#associatedtype.State' class="type">State</a> = <a class="struct" href="../../fst/automaton/struct.IntersectionState.html" title="struct fst::automaton::IntersectionState">IntersectionState</a><A, B></code></span></h4>
|
||
<div class='docblock'><p>The type of the state used in the automaton.</p>
|
||
</div><h4 id='method.start' class="method"><span id='start.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#tymethod.start' class='fnname'>start</a>(&self) -> <a class="struct" href="../../fst/automaton/struct.IntersectionState.html" title="struct fst::automaton::IntersectionState">IntersectionState</a><A, B></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/automaton/mod.rs.html#251-256' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a single start state for this automaton. <a href="../../fst/automaton/trait.Automaton.html#tymethod.start">Read more</a></p>
|
||
</div><h4 id='method.is_match' class="method"><span id='is_match.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#tymethod.is_match' class='fnname'>is_match</a>(&self, state: &<a class="struct" href="../../fst/automaton/struct.IntersectionState.html" title="struct fst::automaton::IntersectionState">IntersectionState</a><A, B>) -> <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/automaton/mod.rs.html#258-260' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns true if and only if <code>state</code> is a match state.</p>
|
||
</div><h4 id='method.can_match' class="method"><span id='can_match.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#method.can_match' class='fnname'>can_match</a>(&self, state: &<a class="struct" href="../../fst/automaton/struct.IntersectionState.html" title="struct fst::automaton::IntersectionState">IntersectionState</a><A, B>) -> <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/automaton/mod.rs.html#262-264' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns true if and only if <code>state</code> can lead to a match in zero or more steps. <a href="../../fst/automaton/trait.Automaton.html#method.can_match">Read more</a></p>
|
||
</div><h4 id='method.will_always_match' class="method"><span id='will_always_match.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#method.will_always_match' class='fnname'>will_always_match</a>(&self, state: &<a class="struct" href="../../fst/automaton/struct.IntersectionState.html" title="struct fst::automaton::IntersectionState">IntersectionState</a><A, B>) -> <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/automaton/mod.rs.html#266-268' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns true if and only if <code>state</code> matches and must match no matter what steps are taken. <a href="../../fst/automaton/trait.Automaton.html#method.will_always_match">Read more</a></p>
|
||
</div><h4 id='method.accept' class="method"><span id='accept.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#tymethod.accept' class='fnname'>accept</a>(<br> &self, <br> state: &<a class="struct" href="../../fst/automaton/struct.IntersectionState.html" title="struct fst::automaton::IntersectionState">IntersectionState</a><A, B>, <br> byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="struct" href="../../fst/automaton/struct.IntersectionState.html" title="struct fst::automaton::IntersectionState">IntersectionState</a><A, B></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/automaton/mod.rs.html#270-279' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return the next state given <code>state</code> and an input.</p>
|
||
</div><h4 id='method.starts_with' class="method"><span id='starts_with.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#method.starts_with' class='fnname'>starts_with</a>(self) -> <a class="struct" href="../../fst/automaton/struct.StartsWith.html" title="struct fst::automaton::StartsWith">StartsWith</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/automaton/mod.rs.html#69-71' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns an automaton that matches the strings that start with something this automaton matches. <a href="../../fst/automaton/trait.Automaton.html#method.starts_with">Read more</a></p>
|
||
</div><h4 id='method.union' class="method"><span id='union.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#method.union' class='fnname'>union</a><Rhs: <a class="trait" href="../../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a>>(self, rhs: Rhs) -> <a class="struct" href="../../fst/automaton/struct.Union.html" title="struct fst::automaton::Union">Union</a><Self, Rhs> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/automaton/mod.rs.html#75-80' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns an automaton that matches the strings matched by either this or the other automaton. <a href="../../fst/automaton/trait.Automaton.html#method.union">Read more</a></p>
|
||
</div><h4 id='method.intersection' class="method"><span id='intersection.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#method.intersection' class='fnname'>intersection</a><Rhs: <a class="trait" href="../../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a>>(self, rhs: Rhs) -> <a class="struct" href="../../fst/automaton/struct.Intersection.html" title="struct fst::automaton::Intersection">Intersection</a><Self, Rhs> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/automaton/mod.rs.html#84-89' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns an automaton that matches the strings matched by both this and the other automaton. <a href="../../fst/automaton/trait.Automaton.html#method.intersection">Read more</a></p>
|
||
</div><h4 id='method.complement' class="method"><span id='complement.v' class='invisible'><code>fn <a href='../../fst/automaton/trait.Automaton.html#method.complement' class='fnname'>complement</a>(self) -> <a class="struct" href="../../fst/automaton/struct.Complement.html" title="struct fst::automaton::Complement">Complement</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/fst/automaton/mod.rs.html#93-95' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns an automaton that matches the strings not matched by this automaton. <a href="../../fst/automaton/trait.Automaton.html#method.complement">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> |