186 lines
48 KiB
HTML
186 lines
48 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 `Automaton` trait in crate `aho_corasick`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Automaton">
|
|||
|
|
|
|||
|
|
<title>aho_corasick::Automaton - 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="../light.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc trait">
|
|||
|
|
<!--[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'>Trait Automaton</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.next_state">next_state</a><a href="#tymethod.has_match">has_match</a><a href="#tymethod.get_match">get_match</a><a href="#tymethod.start_bytes">start_bytes</a><a href="#tymethod.patterns">patterns</a><a href="#tymethod.pattern">pattern</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.len">len</a><a href="#method.is_empty">is_empty</a><a href="#method.find">find</a><a href="#method.find_overlapping">find_overlapping</a><a href="#method.stream_find">stream_find</a><a href="#method.stream_find_overlapping">stream_find_overlapping</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Automaton%3CP%3E">&'a A</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>aho_corasick</a></p><script>window.sidebarCurrent = {name: 'Automaton', ty: 'trait', 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'>Trait <a href='index.html'>aho_corasick</a>::<wbr><a class="trait" href=''>Automaton</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/aho_corasick/autiter.rs.html#11-109' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Automaton<P> {
|
|||
|
|
fn <a href='#tymethod.next_state' class='fnname'>next_state</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.has_match' class='fnname'>has_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.get_match' class='fnname'>get_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, texti: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.start_bytes' class='fnname'>start_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</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>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.patterns' class='fnname'>patterns</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[P]</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.pattern' class='fnname'>pattern</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>P;
|
|||
|
|
|
|||
|
|
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> { ... }
|
|||
|
|
<div class='item-spacer'></div> 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> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.find' class='fnname'>find</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</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>>>(<br> &'a self, <br> s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'s </a>Q<br> ) -> <a class="struct" href="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a><'a, 's, P, Self><br> <span class="where">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>,
|
|||
|
|
{ ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.find_overlapping' class='fnname'>find_overlapping</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</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>>>(<br> &'a self, <br> s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'s </a>Q<br> ) -> <a class="struct" href="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a><'a, 's, P, Self><br> <span class="where">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>,
|
|||
|
|
{ ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.stream_find' class='fnname'>stream_find</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(<br> &'a self, <br> rdr: R<br> ) -> <a class="struct" href="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a><'a, R, P, Self><br> <span class="where">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>,
|
|||
|
|
{ ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.stream_find_overlapping' class='fnname'>stream_find_overlapping</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(<br> &'a self, <br> rdr: R<br> ) -> <a class="struct" href="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a><'a, R, P, Self><br> <span class="where">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>,
|
|||
|
|
{ ... }
|
|||
|
|
}</pre></div><div class='docblock'><p>An abstraction over automatons and their corresponding iterators.
|
|||
|
|
The type parameter <code>P</code> is the type of the pattern that was used to
|
|||
|
|
construct this Automaton.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.next_state' class='method'><span id='next_state.v' class='invisible'><code>fn <a href='#tymethod.next_state' class='fnname'>next_state</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a></code></span></h3><div class='docblock'><p>Return the next state given the current state and next character.</p>
|
|||
|
|
</div><h3 id='tymethod.has_match' class='method'><span id='has_match.v' class='invisible'><code>fn <a href='#tymethod.has_match' class='fnname'>has_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Return true if and only if the given state and current pattern index
|
|||
|
|
indicate a match.</p>
|
|||
|
|
</div><h3 id='tymethod.get_match' class='method'><span id='get_match.v' class='invisible'><code>fn <a href='#tymethod.get_match' class='fnname'>get_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, texti: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a></code></span></h3><div class='docblock'><p>Build a match given the current state, pattern index and input index.</p>
|
|||
|
|
</div><h3 id='tymethod.start_bytes' class='method'><span id='start_bytes.v' class='invisible'><code>fn <a href='#tymethod.start_bytes' class='fnname'>start_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</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></code></span></h3><div class='docblock'><p>Return the set of bytes that have transitions in the root state.</p>
|
|||
|
|
</div><h3 id='tymethod.patterns' class='method'><span id='patterns.v' class='invisible'><code>fn <a href='#tymethod.patterns' class='fnname'>patterns</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[P]</a></code></span></h3><div class='docblock'><p>Returns all of the patterns matched by this automaton.</p>
|
|||
|
|
<p>The order of the patterns is the order in which they were added.</p>
|
|||
|
|
</div><h3 id='tymethod.pattern' class='method'><span id='pattern.v' class='invisible'><code>fn <a href='#tymethod.pattern' class='fnname'>pattern</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>P</code></span></h3><div class='docblock'><p>Returns the pattern indexed at <code>i</code>.</p>
|
|||
|
|
<p>The index corresponds to the position at which the pattern was added
|
|||
|
|
to the automaton, starting at <code>0</code>.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='provided-methods' class='small-section-header'>
|
|||
|
|
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='method.len' class='method'><span id='len.v' class='invisible'><code>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></h3><div class='docblock'><p>Return the number of patterns in the automaton.</p>
|
|||
|
|
</div><h3 id='method.is_empty' class='method'><span id='is_empty.v' class='invisible'><code>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></h3><div class='docblock'><p>Returns true if the automaton has no patterns.</p>
|
|||
|
|
</div><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a><'a, 's, P, A></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a><'a, 's, P, A></h3><code class="content"><span class="where fmt-newline">impl<'a, 's, P, A: <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a><P> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <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="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a><'a, 's, P, A></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="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a>;</span></code></div></div><h3 id='method.find' class='method'><span id='find.v' class='invisible'><code>fn <a href='#method.find' class='fnname'>find</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</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>>>(<br> &'a self, <br> s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'s </a>Q<br>) -> <a class="struct" href="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a><'a, 's, P, 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></h3><div class='docblock'><p>Returns an iterator of non-overlapping matches in <code>s</code>.</p>
|
|||
|
|
</div><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a><'a, 's, P, A></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a><'a, 's, P, A></h3><code class="content"><span class="where fmt-newline">impl<'a, 's, P, A: <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a><P> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <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="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a><'a, 's, P, A></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="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a>;</span></code></div></div><h3 id='method.find_overlapping' class='method'><span id='find_overlapping.v' class='invisible'><code>fn <a href='#method.find_overlapping' class='fnname'>find_overlapping</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</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>>>(<br> &'a self, <br> s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'s </a>Q<br>) -> <a class="struct" href="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a><'a, 's, P, 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></h3><div class='docblock'><p>Returns an iterator of overlapping matches in <code>s</code>.</p>
|
|||
|
|
</div><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a><'a, R, P, A></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a><'a, R, P, A></h3><code class="content"><span class="where fmt-newline">impl<'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>, P, A: <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a><P>> <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="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a><'a, R, P, A></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="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a>>;</span></code></div></div><h3 id='method.stream_find' class='method'><span id='stream_find.v' class='invisible'><code>fn <a href='#method.stream_find' class='fnname'>stream_find</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(&'a self, rdr: R) -> <a class="struct" href="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a><'a, R, P, 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></h3><div class='docblock'><p>Returns an iterator of non-overlapping matches in the given reader.</p>
|
|||
|
|
</div><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a><'a, R, P, A></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a><'a, R, P, A></h3><code class="content"><span class="where fmt-newline">impl<'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>, P, A: <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a><P> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <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="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a><'a, R, P, A></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="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a>>;</span></code></div></div><h3 id='method.stream_find_overlapping' class='method'><span id='stream_find_overlapping.v' class='invisible'><code>fn <a href='#method.stream_find_overlapping' class='fnname'>stream_find_overlapping</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(<br> &'a self, <br> rdr: R<br>) -> <a class="struct" href="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a><'a, R, P, 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></h3><div class='docblock'><p>Returns an iterator of overlapping matches in the given reader.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Automaton%3CP%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</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>>, A: 'a + <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a><P> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a><P> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>A</code><a href='#impl-Automaton%3CP%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/autiter.rs.html#111-136' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.next_state' class="method"><span id='next_state.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.next_state' class='fnname'>next_state</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/autiter.rs.html#113-115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.has_match' class="method"><span id='has_match.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.has_match' class='fnname'>has_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/autiter.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.start_bytes' class="method"><span id='start_bytes.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.start_bytes' class='fnname'>start_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</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></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/autiter.rs.html#121-123' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.patterns' class="method"><span id='patterns.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.patterns' class='fnname'>patterns</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[P]</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/autiter.rs.html#125-127' title='goto source code'>[src]</a></td></tr></tbody></table
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl<P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</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>>> Automaton<P> for <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a><P></code><td><div class='out-of-band'><a class='srclink' href='../src/aho_corasick/full.rs.html#79-117' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl<P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</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>>, T: <a class="trait" href="../aho_corasick/trait.Transitions.html" title="trait aho_corasick::Transitions">Transitions</a>> Automaton<P> for <a class="struct" href="../aho_corasick/struct.AcAutomaton.html" title="struct aho_corasick::AcAutomaton">AcAutomaton</a><P, T></code><td><div class='out-of-band'><a class='srclink' href='../src/aho_corasick/lib.rs.html#252-298' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../implementors/aho_corasick/trait.Automaton.js">
|
|||
|
|
</script></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 = "aho_corasick";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|