# [−] [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.

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

## Methods

### `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 PartialEq<Match> for Match` [src]

#### `fn eq(&self, other: &Match) -> bool` [src]

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

#### `fn ne(&self, other: &Match) -> bool` [src]

This method tests for `!=`.

### `impl Clone for Match` [src]

#### `fn clone(&self) -> Match` [src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Eq for Match` [src]

### `impl Debug for Match` [src]

#### `fn fmt(&self, f: &mut Formatter) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Hash for Match` [src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)` [src]

Feeds this value into the given [`Hasher`]. Read more

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0 [src]

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

## Auto Trait Implementations

### `impl Send for Match`

### `impl Sync for Match`

## Blanket Implementations

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

#### `fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T` [src]

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

#### `fn clone_into(&self, target: &mut T)` [src]

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

recently added

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

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)