[][src]Struct aho_corasick::Match

pub struct Match { /* fields omitted */ }

A representation of a match reported by an Aho-Corasick automaton.

A match has two essential pieces of information: the identifier of the pattern that matched, along with the start and end offsets of the match in the haystack.


Basic usage:

use aho_corasick::AhoCorasick;

let ac = AhoCorasick::new(&[
    "foo", "bar", "baz",
let mat = ac.find("xxx bar xxx").expect("should have a match");
assert_eq!(1, mat.pattern());
assert_eq!(4, mat.start());
assert_eq!(7, mat.end());


impl Match[src]

pub fn pattern(&self) -> usize[src]

Returns the identifier of the pattern that matched.

The identifier of a pattern is derived from the position in which it was originally inserted into the corresponding automaton. The first pattern has identifier 0, and each subsequent pattern is 1, 2 and so on.

pub fn start(&self) -> usize[src]

The starting position of the match.

pub fn end(&self) -> usize[src]

The ending position of the match.

pub fn is_empty(&self) -> bool[src]

Returns true if and only if this match is empty. That is, when start() == end().

An empty match can only be returned when the empty string was among the patterns used to build the Aho-Corasick automaton.

Trait Implementations

impl Clone for Match[src]

impl Debug for Match[src]

impl Eq for Match[src]

impl Hash for Match[src]

impl PartialEq<Match> for Match[src]

impl StructuralEq for Match[src]

impl StructuralPartialEq for Match[src]

Auto Trait Implementations

impl RefUnwindSafe for Match

impl Send for Match

impl Sync for Match

impl Unpin for Match

impl UnwindSafe for Match

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.