| <!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="A trait that abstracts over Aho-Corasick automata."><meta name="keywords" content="rust, rustlang, rust-lang, Automaton"><title>Automaton in aho_corasick::automaton - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../aho_corasick/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../aho_corasick/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Automaton</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_dead">is_dead</a></li><li><a href="#tymethod.is_match">is_match</a></li><li><a href="#tymethod.is_special">is_special</a></li><li><a href="#tymethod.is_start">is_start</a></li><li><a href="#tymethod.match_kind">match_kind</a></li><li><a href="#tymethod.match_len">match_len</a></li><li><a href="#tymethod.match_pattern">match_pattern</a></li><li><a href="#tymethod.max_pattern_len">max_pattern_len</a></li><li><a href="#tymethod.memory_usage">memory_usage</a></li><li><a href="#tymethod.min_pattern_len">min_pattern_len</a></li><li><a href="#tymethod.next_state">next_state</a></li><li><a href="#tymethod.pattern_len">pattern_len</a></li><li><a href="#tymethod.patterns_len">patterns_len</a></li><li><a href="#tymethod.prefilter">prefilter</a></li><li><a href="#tymethod.start_state">start_state</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.try_find">try_find</a></li><li><a href="#method.try_find_iter">try_find_iter</a></li><li><a href="#method.try_find_overlapping">try_find_overlapping</a></li><li><a href="#method.try_find_overlapping_iter">try_find_overlapping_iter</a></li><li><a href="#method.try_replace_all">try_replace_all</a></li><li><a href="#method.try_replace_all_bytes">try_replace_all_bytes</a></li><li><a href="#method.try_replace_all_with">try_replace_all_with</a></li><li><a href="#method.try_replace_all_with_bytes">try_replace_all_with_bytes</a></li><li><a href="#method.try_stream_find_iter">try_stream_find_iter</a></li><li><a href="#method.try_stream_replace_all">try_stream_replace_all</a></li><li><a href="#method.try_stream_replace_all_with">try_stream_replace_all_with</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Automaton-for-%26%27a%20A">&'a A</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In aho_corasick::automaton</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">aho_corasick</a>::<wbr><a href="index.html">automaton</a>::<wbr><a class="trait" href="#">Automaton</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/aho_corasick/automaton.rs.html#198-637">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub unsafe trait Automaton: Sealed { |
| <details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 26 methods</span></summary> fn <a href="#tymethod.start_state" class="fnname">start_state</a>(&self, anchored: <a class="enum" href="../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.next_state" class="fnname">next_state</a>(&self, anchored: <a class="enum" href="../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.is_special" class="fnname">is_special</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.is_dead" class="fnname">is_dead</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.is_match" class="fnname">is_match</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.is_start" class="fnname">is_start</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.match_kind" class="fnname">match_kind</a>(&self) -> <a class="enum" href="../enum.MatchKind.html" title="enum aho_corasick::MatchKind">MatchKind</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.match_len" class="fnname">match_len</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.match_pattern" class="fnname">match_pattern</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.patterns_len" class="fnname">patterns_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.pattern_len" class="fnname">pattern_len</a>(&self, pid: <a class="struct" href="../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.min_pattern_len" class="fnname">min_pattern_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.max_pattern_len" class="fnname">max_pattern_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.memory_usage" class="fnname">memory_usage</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.prefilter" class="fnname">prefilter</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="struct.Prefilter.html" title="struct aho_corasick::automaton::Prefilter">Prefilter</a>>; |
| |
| fn <a href="#method.try_find" class="fnname">try_find</a>(&self, input: &<a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</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="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</a>>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_find_overlapping" class="fnname">try_find_overlapping</a>(<br> &self,<br> input: &<a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'_>,<br> state: &mut <a class="struct" href="struct.OverlappingState.html" title="struct aho_corasick::automaton::OverlappingState">OverlappingState</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_find_iter" class="fnname">try_find_iter</a><'a, 'h>(<br> &'a self,<br> input: <a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'h><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.FindIter.html" title="struct aho_corasick::automaton::FindIter">FindIter</a><'a, 'h, Self>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_find_overlapping_iter" class="fnname">try_find_overlapping_iter</a><'a, 'h>(<br> &'a self,<br> input: <a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'h><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.FindOverlappingIter.html" title="struct aho_corasick::automaton::FindOverlappingIter">FindOverlappingIter</a><'a, 'h, Self>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_replace_all" class="fnname">try_replace_all</a><B>(<br> &self,<br> haystack: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,<br> replace_with: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[B]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> B: <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.str.html">str</a>></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_replace_all_bytes" class="fnname">try_replace_all_bytes</a><B>(<br> &self,<br> haystack: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],<br> replace_with: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[B]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> B: <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.u8.html">u8</a>]></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_replace_all_with" class="fnname">try_replace_all_with</a><F>(<br> &self,<br> haystack: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,<br> dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,<br> replace_with: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</a>, &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_replace_all_with_bytes" class="fnname">try_replace_all_with_bytes</a><F>(<br> &self,<br> haystack: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],<br> dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>,<br> replace_with: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</a>, &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>], &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</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.bool.html">bool</a></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_stream_find_iter" class="fnname">try_stream_find_iter</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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.StreamFindIter.html" title="struct aho_corasick::automaton::StreamFindIter">StreamFindIter</a><'a, Self, R>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_stream_replace_all" class="fnname">try_stream_replace_all</a><R, W, B>(<br> &self,<br> rdr: R,<br> wtr: W,<br> replace_with: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[B]</a><br> ) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><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>,<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,<br> B: <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.u8.html">u8</a>]></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.try_stream_replace_all_with" class="fnname">try_stream_replace_all_with</a><R, W, F>(<br> &self,<br> rdr: R,<br> wtr: W,<br> replace_with: F<br> ) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><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>,<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</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.reference.html">&mut </a>W) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></span>, |
| { ... } |
| </details>}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait that abstracts over Aho-Corasick automata.</p> |
| <p>This trait primarily exists for niche use cases such as:</p> |
| <ul> |
| <li>Using an NFA or DFA directly, bypassing the top-level |
| <a href="../struct.AhoCorasick.html"><code>AhoCorasick</code></a> searcher. Currently, these include |
| <a href="../nfa/noncontiguous/struct.NFA.html"><code>noncontiguous::NFA</code></a>, |
| <a href="../nfa/contiguous/struct.NFA.html"><code>contiguous::NFA</code></a> and |
| <a href="../dfa/struct.DFA.html"><code>dfa::DFA</code></a>.</li> |
| <li>Implementing your own custom search routine by walking the automaton |
| yourself. This might be useful for implementing search on non-contiguous |
| strings or streams.</li> |
| </ul> |
| <p>For most use cases, it is not expected that users will need |
| to use or even know about this trait. Indeed, the top level |
| <a href="../struct.AhoCorasick.html"><code>AhoCorasick</code></a> searcher does not expose any details |
| about this trait, nor does it implement it itself.</p> |
| <p>Note that this trait defines a number of default methods, such as |
| <a href="trait.Automaton.html#method.try_find" title="Automaton::try_find"><code>Automaton::try_find</code></a> and <a href="trait.Automaton.html#method.try_find_iter" title="Automaton::try_find_iter"><code>Automaton::try_find_iter</code></a>, which implement |
| higher level search routines in terms of the lower level automata API.</p> |
| <h2 id="sealed"><a href="#sealed">Sealed</a></h2> |
| <p>Currently, this trait is sealed. That means users of this crate can write |
| generic routines over this trait but cannot implement it themselves. This |
| restriction may be lifted in the future, but sealing the trait permits |
| adding new required methods in a backwards compatible fashion.</p> |
| <h2 id="special-states"><a href="#special-states">Special states</a></h2> |
| <p>This trait encodes a notion of “special” states in an automaton. Namely, |
| a state is treated as special if it is a dead, match or start state:</p> |
| <ul> |
| <li>A dead state is a state that cannot be left once entered. All transitions |
| on a dead state lead back to itself. The dead state is meant to be treated |
| as a sentinel indicating that the search should stop and return a match if |
| one has been found, and nothing otherwise.</li> |
| <li>A match state is a state that indicates one or more patterns have |
| matched. Depending on the <a href="../enum.MatchKind.html" title="MatchKind"><code>MatchKind</code></a> of the automaton, a search may |
| stop once a match is seen, or it may continue looking for matches until |
| it enters a dead state or sees the end of the haystack.</li> |
| <li>A start state is a state that a search begins in. It is useful to know |
| when a search enters a start state because it may mean that a prefilter can |
| be used to skip ahead and quickly look for candidate matches. Unlike dead |
| and match states, it is never necessary to explicitly handle start states |
| for correctness. Indeed, in this crate, implementations of <code>Automaton</code> |
| will only treat start states as “special” when a prefilter is enabled and |
| active. Otherwise, treating it as special has no purpose and winds up |
| slowing down the overall search because it results in ping-ponging between |
| the main state transition and the “special” state logic.</li> |
| </ul> |
| <p>Since checking whether a state is special by doing three different |
| checks would be too expensive inside a fast search loop, the |
| <a href="trait.Automaton.html#tymethod.is_special" title="Automaton::is_special"><code>Automaton::is_special</code></a> method is provided for quickly checking whether |
| the state is special. The <code>Automaton::is_dead</code>, <code>Automaton::is_match</code> and |
| <code>Automaton::is_start</code> predicates can then be used to determine which kind |
| of special state it is.</p> |
| <h2 id="panics"><a href="#panics">Panics</a></h2> |
| <p>Most of the APIs on this trait should panic or give incorrect results |
| if invalid inputs are given to it. For example, <code>Automaton::next_state</code> |
| has unspecified behavior if the state ID given to it is not a valid |
| state ID for the underlying automaton. Valid state IDs can only be |
| retrieved in one of two ways: calling <code>Automaton::start_state</code> or calling |
| <code>Automaton::next_state</code> with a valid state ID.</p> |
| <h2 id="safety"><a href="#safety">Safety</a></h2> |
| <p>This trait is not safe to implement so that code may rely on the |
| correctness of implementations of this trait to avoid undefined behavior. |
| The primary correctness guarantees are:</p> |
| <ul> |
| <li><code>Automaton::start_state</code> always returns a valid state ID or an error or |
| panics.</li> |
| <li><code>Automaton::next_state</code>, when given a valid state ID, always returns |
| a valid state ID for all values of <code>anchored</code> and <code>byte</code>, or otherwise |
| panics.</li> |
| </ul> |
| <p>In general, the rest of the methods on <code>Automaton</code> need to uphold their |
| contracts as well. For example, <code>Automaton::is_dead</code> should only returns |
| true if the given state ID is actually a dead state.</p> |
| <p>Note that currently this crate does not rely on the safety property defined |
| here to avoid undefined behavior. Instead, this was done to make it |
| <em>possible</em> to do in the future.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <p>This example shows how one might implement a basic but correct search |
| routine. We keep things simple by not using prefilters or worrying about |
| anchored searches, but do make sure our search is correct for all possible |
| <a href="../enum.MatchKind.html" title="MatchKind"><code>MatchKind</code></a> semantics. (The comments in the code below note the parts |
| that are needed to support certain <code>MatchKind</code> semantics.)</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>aho_corasick::{ |
| automaton::Automaton, |
| nfa::noncontiguous::NFA, |
| Anchored, Match, MatchError, MatchKind, |
| }; |
| |
| <span class="comment">// Run an unanchored search for 'aut' in 'haystack'. Return the first match |
| // seen according to the automaton's match semantics. This returns an error |
| // if the given automaton does not support unanchored searches. |
| </span><span class="kw">fn </span>find<A: Automaton>( |
| aut: A, |
| haystack: <span class="kw-2">&</span>[u8], |
| ) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><Match>, MatchError> { |
| <span class="kw">let </span><span class="kw-2">mut </span>sid = aut.start_state(Anchored::No)<span class="question-mark">?</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>at = <span class="number">0</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>mat = <span class="prelude-val">None</span>; |
| <span class="kw">let </span>get_match = |sid, at| { |
| <span class="kw">let </span>pid = aut.match_pattern(sid, <span class="number">0</span>); |
| <span class="kw">let </span>len = aut.pattern_len(pid); |
| Match::new(pid, (at - len)..at) |
| }; |
| <span class="comment">// Start states can be match states! |
| </span><span class="kw">if </span>aut.is_match(sid) { |
| mat = <span class="prelude-val">Some</span>(get_match(sid, at)); |
| <span class="comment">// Standard semantics require matches to be reported as soon as |
| // they're seen. Otherwise, we continue until we see a dead state |
| // or the end of the haystack. |
| </span><span class="kw">if </span><span class="macro">matches!</span>(aut.match_kind(), MatchKind::Standard) { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(mat); |
| } |
| } |
| <span class="kw">while </span>at < haystack.len() { |
| sid = aut.next_state(Anchored::No, sid, haystack[at]); |
| <span class="kw">if </span>aut.is_special(sid) { |
| <span class="kw">if </span>aut.is_dead(sid) { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(mat); |
| } <span class="kw">else if </span>aut.is_match(sid) { |
| mat = <span class="prelude-val">Some</span>(get_match(sid, at + <span class="number">1</span>)); |
| <span class="comment">// As above, standard semantics require that we return |
| // immediately once a match is found. |
| </span><span class="kw">if </span><span class="macro">matches!</span>(aut.match_kind(), MatchKind::Standard) { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(mat); |
| } |
| } |
| } |
| at += <span class="number">1</span>; |
| } |
| <span class="prelude-val">Ok</span>(mat) |
| } |
| |
| <span class="comment">// Show that it works for standard searches. |
| </span><span class="kw">let </span>nfa = NFA::new(<span class="kw-2">&</span>[<span class="string">"samwise"</span>, <span class="string">"sam"</span>]).unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(Match::must(<span class="number">1</span>, <span class="number">0</span>..<span class="number">3</span>)), find(<span class="kw-2">&</span>nfa, <span class="string">b"samwise"</span>)<span class="question-mark">?</span>); |
| |
| <span class="comment">// But also works when using leftmost-first. Notice how the match result |
| // has changed! |
| </span><span class="kw">let </span>nfa = NFA::builder() |
| .match_kind(MatchKind::LeftmostFirst) |
| .build(<span class="kw-2">&</span>[<span class="string">"samwise"</span>, <span class="string">"sam"</span>]) |
| .unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(Match::must(<span class="number">0</span>, <span class="number">0</span>..<span class="number">7</span>)), find(<span class="kw-2">&</span>nfa, <span class="string">b"samwise"</span>)<span class="question-mark">?</span>); |
| </code></pre></div> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.start_state" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#210">source</a><h4 class="code-header">fn <a href="#tymethod.start_state" class="fnname">start_state</a>(&self, anchored: <a class="enum" href="../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>></h4></section></summary><div class="docblock"><p>Returns the starting state for the given anchor mode.</p> |
| <p>Upon success, the state ID returned is guaranteed to be valid for |
| this automaton.</p> |
| <h5 id="errors"><a href="#errors">Errors</a></h5> |
| <p>This returns an error when the given search configuration is not |
| supported by the underlying automaton. For example, if the underlying |
| automaton only supports unanchored searches but the given configuration |
| was set to an anchored search, then this must return an error.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.next_state" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#237-242">source</a><h4 class="code-header">fn <a href="#tymethod.next_state" class="fnname">next_state</a>(&self, anchored: <a class="enum" href="../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a></h4></section></summary><div class="docblock"><p>Performs a state transition from <code>sid</code> for <code>byte</code> and returns the next |
| state.</p> |
| <p><code>anchored</code> should be <a href="../enum.Anchored.html#variant.Yes" title="Anchored::Yes"><code>Anchored::Yes</code></a> when executing an anchored |
| search and <a href="../enum.Anchored.html#variant.No" title="Anchored::No"><code>Anchored::No</code></a> otherwise. For some implementations of |
| <code>Automaton</code>, it is required to know whether the search is anchored |
| or not in order to avoid following failure transitions. Other |
| implementations may ignore <code>anchored</code> altogether and depend on |
| <code>Automaton::start_state</code> returning a state that walks a different path |
| through the automaton depending on whether the search is anchored or |
| not.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>This routine may panic or return incorrect results when the given state |
| ID is invalid. A state ID is valid if and only if:</p> |
| <ol> |
| <li>It came from a call to <code>Automaton::start_state</code>, or</li> |
| <li>It came from a previous call to <code>Automaton::next_state</code> with a |
| valid state ID.</li> |
| </ol> |
| <p>Implementations must treat all possible values of <code>byte</code> as valid.</p> |
| <p>Implementations may panic on unsupported values of <code>anchored</code>, but are |
| not required to do so.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_special" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#253">source</a><h4 class="code-header">fn <a href="#tymethod.is_special" class="fnname">is_special</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the given ID represents a “special” state. A special |
| state is a dead, match or start state.</p> |
| <p>Note that implementations may choose to return false when the given ID |
| corresponds to a start state. Namely, it always correct to treat start |
| states as non-special. Implementations must return true for states that |
| are dead or contain matches.</p> |
| <p>This has unspecified behavior when given an invalid state ID.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_dead" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#263">source</a><h4 class="code-header">fn <a href="#tymethod.is_dead" class="fnname">is_dead</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the given ID represents a dead state.</p> |
| <p>A dead state is a type of “sink” in a finite state machine. It |
| corresponds to a state whose transitions all loop back to itself. That |
| is, once entered, it can never be left. In practice, it serves as a |
| sentinel indicating that the search should terminate.</p> |
| <p>This has unspecified behavior when given an invalid state ID.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_match" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#276">source</a><h4 class="code-header">fn <a href="#tymethod.is_match" class="fnname">is_match</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the given ID represents a match state.</p> |
| <p>A match state is always associated with one or more pattern IDs that |
| matched at the position in the haystack when the match state was |
| entered. When a match state is entered, the match semantics dictate |
| whether it should be returned immediately (for <code>MatchKind::Standard</code>) |
| or if the search should continue (for <code>MatchKind::LeftmostFirst</code> and |
| <code>MatchKind::LeftmostLongest</code>) until a dead state is seen or the end of |
| the haystack has been reached.</p> |
| <p>This has unspecified behavior when given an invalid state ID.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.is_start" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#293">source</a><h4 class="code-header">fn <a href="#tymethod.is_start" class="fnname">is_start</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the given ID represents a start state.</p> |
| <p>While it is never incorrect to ignore start states during a search |
| (except for the start of the search of course), knowing whether one has |
| entered a start state can be useful for certain classes of performance |
| optimizations. For example, if one is in a start state, it may be legal |
| to try to skip ahead and look for match candidates more quickly than |
| would otherwise be accomplished by walking the automaton.</p> |
| <p>Implementations of <code>Automaton</code> in this crate “unspecialize” start |
| states when a prefilter is not active or enabled. In this case, it |
| is possible for <code>Automaton::is_special(sid)</code> to return false while |
| <code>Automaton::is_start(sid)</code> returns true.</p> |
| <p>This has unspecified behavior when given an invalid state ID.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.match_kind" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#296">source</a><h4 class="code-header">fn <a href="#tymethod.match_kind" class="fnname">match_kind</a>(&self) -> <a class="enum" href="../enum.MatchKind.html" title="enum aho_corasick::MatchKind">MatchKind</a></h4></section></summary><div class="docblock"><p>Returns the match semantics that this automaton was built with.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.match_len" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#302">source</a><h4 class="code-header">fn <a href="#tymethod.match_len" class="fnname">match_len</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the total number of matches for the given state ID.</p> |
| <p>This has unspecified behavior if the given ID does not refer to a match |
| state.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.match_pattern" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#314">source</a><h4 class="code-header">fn <a href="#tymethod.match_pattern" class="fnname">match_pattern</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a></h4></section></summary><div class="docblock"><p>Returns the pattern ID for the match state given by <code>sid</code> at the |
| <code>index</code> given.</p> |
| <p>Typically, <code>index</code> is only ever greater than <code>0</code> when implementing an |
| overlapping search. Otherwise, it’s likely that your search only cares |
| about reporting the first pattern ID in a match state.</p> |
| <p>This has unspecified behavior if the given ID does not refer to a match |
| state, or if the index is greater than or equal to the total number of |
| matches in this match state.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.patterns_len" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#317">source</a><h4 class="code-header">fn <a href="#tymethod.patterns_len" class="fnname">patterns_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the total number of patterns compiled into this automaton.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.pattern_len" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#324">source</a><h4 class="code-header">fn <a href="#tymethod.pattern_len" class="fnname">pattern_len</a>(&self, pid: <a class="struct" href="../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the length of the pattern for the given ID.</p> |
| <p>This has unspecified behavior when given an invalid pattern |
| ID. A pattern ID is valid if and only if it is less than |
| <code>Automaton::patterns_len</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.min_pattern_len" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#328">source</a><h4 class="code-header">fn <a href="#tymethod.min_pattern_len" class="fnname">min_pattern_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the length, in bytes, of the shortest pattern in this |
| automaton.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.max_pattern_len" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#331">source</a><h4 class="code-header">fn <a href="#tymethod.max_pattern_len" class="fnname">max_pattern_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the length, in bytes, of the longest pattern in this automaton.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.memory_usage" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#334">source</a><h4 class="code-header">fn <a href="#tymethod.memory_usage" class="fnname">memory_usage</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the heap memory usage, in bytes, used by this automaton.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.prefilter" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#346">source</a><h4 class="code-header">fn <a href="#tymethod.prefilter" class="fnname">prefilter</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="struct.Prefilter.html" title="struct aho_corasick::automaton::Prefilter">Prefilter</a>></h4></section></summary><div class="docblock"><p>Returns a prefilter, if available, that can be used to accelerate |
| searches for this automaton.</p> |
| <p>The typical way this is used is when the start state is entered during |
| a search. When that happens, one can use a prefilter to skip ahead and |
| look for candidate matches without having to walk the automaton on the |
| bytes between candidates.</p> |
| <p>Typically a prefilter is only available when there are a small (<100) |
| number of patterns built into the automaton.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#354-359">source</a><h4 class="code-header">fn <a href="#method.try_find" class="fnname">try_find</a>(&self, input: &<a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</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="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</a>>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>></h4></section></summary><div class="docblock"><p>Executes a non-overlapping search with this automaton using the given |
| configuration.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_find"><code>AhoCorasick::try_find</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find_overlapping" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#367-373">source</a><h4 class="code-header">fn <a href="#method.try_find_overlapping" class="fnname">try_find_overlapping</a>(<br> &self,<br> input: &<a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'_>,<br> state: &mut <a class="struct" href="struct.OverlappingState.html" title="struct aho_corasick::automaton::OverlappingState">OverlappingState</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>></h4></section></summary><div class="docblock"><p>Executes a overlapping search with this automaton using the given |
| configuration.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_find_overlapping"><code>AhoCorasick::try_find_overlapping</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find_iter" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#381-389">source</a><h4 class="code-header">fn <a href="#method.try_find_iter" class="fnname">try_find_iter</a><'a, 'h>(<br> &'a self,<br> input: <a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'h><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.FindIter.html" title="struct aho_corasick::automaton::FindIter">FindIter</a><'a, 'h, Self>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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></h4></section></summary><div class="docblock"><p>Returns an iterator of non-overlapping matches with this automaton |
| using the given configuration.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_find_iter"><code>AhoCorasick::try_find_iter</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find_overlapping_iter" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#397-423">source</a><h4 class="code-header">fn <a href="#method.try_find_overlapping_iter" class="fnname">try_find_overlapping_iter</a><'a, 'h>(<br> &'a self,<br> input: <a class="struct" href="../struct.Input.html" title="struct aho_corasick::Input">Input</a><'h><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.FindOverlappingIter.html" title="struct aho_corasick::automaton::FindOverlappingIter">FindOverlappingIter</a><'a, 'h, Self>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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></h4></section></summary><div class="docblock"><p>Returns an iterator of overlapping matches with this automaton |
| using the given configuration.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_find_overlapping_iter"><code>AhoCorasick::try_find_overlapping_iter</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#433-454">source</a><h4 class="code-header">fn <a href="#method.try_replace_all" class="fnname">try_replace_all</a><B>(<br> &self,<br> haystack: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,<br> replace_with: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[B]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> B: <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.str.html">str</a>>,</span></h4></section></summary><div class="docblock"><p>Replaces all non-overlapping matches in <code>haystack</code> with |
| strings from <code>replace_with</code> depending on the pattern that |
| matched. The <code>replace_with</code> slice must have length equal to |
| <code>Automaton::patterns_len</code>.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_replace_all"><code>AhoCorasick::try_replace_all</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#464-485">source</a><h4 class="code-header">fn <a href="#method.try_replace_all_bytes" class="fnname">try_replace_all_bytes</a><B>(<br> &self,<br> haystack: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],<br> replace_with: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[B]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> B: <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.u8.html">u8</a>]>,</span></h4></section></summary><div class="docblock"><p>Replaces all non-overlapping matches in <code>haystack</code> with |
| strings from <code>replace_with</code> depending on the pattern that |
| matched. The <code>replace_with</code> slice must have length equal to |
| <code>Automaton::patterns_len</code>.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_replace_all_bytes"><code>AhoCorasick::try_replace_all_bytes</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all_with" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#493-522">source</a><h4 class="code-header">fn <a href="#method.try_replace_all_with" class="fnname">try_replace_all_with</a><F>(<br> &self,<br> haystack: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,<br> dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,<br> replace_with: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</a>, &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,</span></h4></section></summary><div class="docblock"><p>Replaces all non-overlapping matches in <code>haystack</code> by calling the |
| <code>replace_with</code> closure given.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_replace_all_with"><code>AhoCorasick::try_replace_all_with</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all_with_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#530-550">source</a><h4 class="code-header">fn <a href="#method.try_replace_all_with_bytes" class="fnname">try_replace_all_with_bytes</a><F>(<br> &self,<br> haystack: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],<br> dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>,<br> replace_with: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</a>, &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>], &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</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.bool.html">bool</a>,</span></h4></section></summary><div class="docblock"><p>Replaces all non-overlapping matches in <code>haystack</code> by calling the |
| <code>replace_with</code> closure given.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_replace_all_with_bytes"><code>AhoCorasick::try_replace_all_with_bytes</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_stream_find_iter" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#559-567">source</a><h4 class="code-header">fn <a href="#method.try_stream_find_iter" class="fnname">try_stream_find_iter</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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.StreamFindIter.html" title="struct aho_corasick::automaton::StreamFindIter">StreamFindIter</a><'a, Self, R>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><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></h4></section></summary><div class="docblock"><p>Returns an iterator of non-overlapping matches with this automaton |
| from the stream given.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_stream_find_iter"><code>AhoCorasick::try_stream_find_iter</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_stream_replace_all" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#578-599">source</a><h4 class="code-header">fn <a href="#method.try_stream_replace_all" class="fnname">try_stream_replace_all</a><R, W, B>(<br> &self,<br> rdr: R,<br> wtr: W,<br> replace_with: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[B]</a><br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><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>,<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,<br> B: <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.u8.html">u8</a>]>,</span></h4></section></summary><div class="docblock"><p>Replaces all non-overlapping matches in <code>rdr</code> with strings from |
| <code>replace_with</code> depending on the pattern that matched, and writes the |
| result to <code>wtr</code>. The <code>replace_with</code> slice must have length equal to |
| <code>Automaton::patterns_len</code>.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_stream_replace_all"><code>AhoCorasick::try_stream_replace_all</code></a> |
| for more documentation and examples.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_stream_replace_all_with" class="method has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#608-636">source</a><h4 class="code-header">fn <a href="#method.try_stream_replace_all_with" class="fnname">try_stream_replace_all_with</a><R, W, F>(<br> &self,<br> rdr: R,<br> wtr: W,<br> replace_with: F<br>) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>><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>,<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../struct.Match.html" title="struct aho_corasick::Match">Match</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.reference.html">&mut </a>W) -> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>,</span></h4></section></summary><div class="docblock"><p>Replaces all non-overlapping matches in <code>rdr</code> by calling the |
| <code>replace_with</code> closure given and writing the result to <code>wtr</code>.</p> |
| <p>See |
| <a href="../struct.AhoCorasick.html#method.try_stream_replace_all_with"><code>AhoCorasick::try_stream_replace_all_with</code></a> |
| for more documentation and examples.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Automaton-for-%26%27a%20A" class="impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#641-721">source</a><a href="#impl-Automaton-for-%26%27a%20A" class="anchor"></a><h3 class="code-header">impl<'a, A: <a class="trait" href="trait.Automaton.html" title="trait aho_corasick::automaton::Automaton">Automaton</a> + ?<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="trait.Automaton.html" title="trait aho_corasick::automaton::Automaton">Automaton</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>A</h3></section></summary><div class="impl-items"><section id="method.start_state" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#643-645">source</a><a href="#method.start_state" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.start_state" class="fnname">start_state</a>(&self, anchored: <a class="enum" href="../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, <a class="struct" href="../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>></h4></section><section id="method.next_state" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#648-655">source</a><a href="#method.next_state" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.next_state" class="fnname">next_state</a>(&self, anchored: <a class="enum" href="../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a></h4></section><section id="method.is_special" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#658-660">source</a><a href="#method.is_special" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_special" class="fnname">is_special</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_dead" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#663-665">source</a><a href="#method.is_dead" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_dead" class="fnname">is_dead</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_match" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#668-670">source</a><a href="#method.is_match" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_match" class="fnname">is_match</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.is_start" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#673-675">source</a><a href="#method.is_start" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.is_start" class="fnname">is_start</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.match_kind" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#678-680">source</a><a href="#method.match_kind" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.match_kind" class="fnname">match_kind</a>(&self) -> <a class="enum" href="../enum.MatchKind.html" title="enum aho_corasick::MatchKind">MatchKind</a></h4></section><section id="method.match_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#683-685">source</a><a href="#method.match_len" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.match_len" class="fnname">match_len</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="method.match_pattern" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#688-690">source</a><a href="#method.match_pattern" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.match_pattern" class="fnname">match_pattern</a>(&self, sid: <a class="struct" href="struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a></h4></section><section id="method.patterns_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#693-695">source</a><a href="#method.patterns_len" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.patterns_len" class="fnname">patterns_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="method.pattern_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#698-700">source</a><a href="#method.pattern_len" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.pattern_len" class="fnname">pattern_len</a>(&self, pid: <a class="struct" href="../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="method.min_pattern_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#703-705">source</a><a href="#method.min_pattern_len" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.min_pattern_len" class="fnname">min_pattern_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="method.max_pattern_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#708-710">source</a><a href="#method.max_pattern_len" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.max_pattern_len" class="fnname">max_pattern_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="method.memory_usage" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#713-715">source</a><a href="#method.memory_usage" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.memory_usage" class="fnname">memory_usage</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="method.prefilter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/automaton.rs.html#718-720">source</a><a href="#method.prefilter" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.prefilter" class="fnname">prefilter</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="struct.Prefilter.html" title="struct aho_corasick::automaton::Prefilter">Prefilter</a>></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-Automaton-for-DFA" class="impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/dfa.rs.html#190-303">source</a><a href="#impl-Automaton-for-DFA" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Automaton.html" title="trait aho_corasick::automaton::Automaton">Automaton</a> for <a class="struct" href="../dfa/struct.DFA.html" title="struct aho_corasick::dfa::DFA">DFA</a></h3></section><section id="impl-Automaton-for-NFA" class="impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/nfa/contiguous.rs.html#176-322">source</a><a href="#impl-Automaton-for-NFA" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Automaton.html" title="trait aho_corasick::automaton::Automaton">Automaton</a> for aho_corasick::nfa::contiguous::<a class="struct" href="../nfa/contiguous/struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</a></h3></section><section id="impl-Automaton-for-NFA-1" class="impl has-srclink"><a class="srclink rightside" href="../../src/aho_corasick/nfa/noncontiguous.rs.html#244-352">source</a><a href="#impl-Automaton-for-NFA-1" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Automaton.html" title="trait aho_corasick::automaton::Automaton">Automaton</a> for aho_corasick::nfa::noncontiguous::<a class="struct" href="../nfa/noncontiguous/struct.NFA.html" title="struct aho_corasick::nfa::noncontiguous::NFA">NFA</a></h3></section></div><script src="../../implementors/aho_corasick/automaton/trait.Automaton.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="aho_corasick" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
