Struct aho_corasick::MatchError

pub struct MatchError(Box<MatchErrorKind>);

An error that occurred during an Aho-Corasick search.

An error that occurs during a search is limited to some kind of misconfiguration that resulted in an illegal call. Stated differently, whether an error occurs is not dependent on the specific bytes in the haystack.

Examples of misconfiguration:

• Executing a stream or overlapping search on a searcher that was built was something other than MatchKind::Standard semantics.
• Requested an anchored or an unanchored search on a searcher that doesn’t support unanchored or anchored searches, respectively.

When the std feature is enabled, this implements the std::error::Error trait.

Tuple Fields

0: Box<MatchErrorKind>

Implementations

impl MatchError

pub fn new(kind: MatchErrorKind) -> MatchError

Create a new error value with the given kind.

This is a more verbose version of the kind-specific constructors, e.g., MatchError::unsupported_stream.

pub fn kind(&self) -> &MatchErrorKind

Returns a reference to the underlying error kind.

pub fn invalid_input_anchored() -> MatchError

Create a new “invalid anchored search” error. This occurs when the caller requests an anchored search but where anchored searches aren’t supported.

This is the same as calling MatchError::new with a MatchErrorKind::InvalidInputAnchored kind.

pub fn invalid_input_unanchored() -> MatchError

Create a new “invalid unanchored search” error. This occurs when the caller requests an unanchored search but where unanchored searches aren’t supported.

This is the same as calling MatchError::new with a MatchErrorKind::InvalidInputUnanchored kind.

pub fn unsupported_stream(got: MatchKind) -> MatchError

Create a new “unsupported stream search” error. This occurs when the caller requests a stream search while using an Aho-Corasick automaton with a match kind other than MatchKind::Standard.

The match kind given should be the match kind of the automaton. It should never be MatchKind::Standard.

pub fn unsupported_overlapping(got: MatchKind) -> MatchError

Create a new “unsupported overlapping search” error. This occurs when the caller requests an overlapping search while using an Aho-Corasick automaton with a match kind other than MatchKind::Standard.

The match kind given should be the match kind of the automaton. It should never be MatchKind::Standard.

pub fn unsupported_empty() -> MatchError

Create a new “unsupported empty pattern” error. This occurs when the caller requests a search for which matching an automaton that contains an empty pattern string is not supported.

Trait Implementations

impl Clone for MatchError

fn clone(&self) -> MatchError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MatchError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for MatchError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for MatchError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type based access to context intended for error reports.

impl PartialEq for MatchError

fn eq(&self, other: &MatchError) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MatchError

impl StructuralPartialEq for MatchError