Struct BuildError

pub struct BuildError { /* private fields */ }

An error that can occurred during the construction of a thompson NFA.

This error does not provide many introspection capabilities. There are generally only two things you can do with it:

• Obtain a human readable message via its std::fmt::Display impl.
• Access an underlying regex_syntax::Error type from its source method via the std::error::Error trait. This error only occurs when using convenience routines for building an NFA directly from a pattern string.

Otherwise, errors typically occur when a limit has been breeched. For example, if the total heap usage of the compiled NFA exceeds the limit set by Config::nfa_size_limit, then building the NFA will fail.

Implementations

impl BuildError

pub fn size_limit(&self) -> Option<usize>

If this error occurred because the NFA exceeded the configured size limit before being built, then this returns the configured size limit.

The limit returned is what was configured, and corresponds to the maximum amount of heap usage in bytes.

Trait Implementations

impl Clone for BuildError

fn clone(&self) -> BuildError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildError

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

Formats the value using the given formatter.

impl Display for BuildError

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

Formats the value using the given formatter.

impl Error for BuildError

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

Returns 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.