pub struct Match { /* private fields */ }
Expand description

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.

Examples

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());

Implementations

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.

The starting position of the match.

The ending position of the match.

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.