Enum Error

pub enum Error {
    Anchor,
    Syntax(Box<Error>),
}

Error returned by Regex::compile() and Regex::with_hir().

Examples

let gen = rand_regex::Regex::compile(r"^.{4}\b.{4}$", 100);
assert_eq!(gen.err(), Some(rand_regex::Error::Anchor));

Variants

Anchor

Anchors (^, $, \A, \z) and word boundary assertions (\b, \B) are not supported.

If you really need to include anchors, please consider using rejection sampling e.g.

use rand::Rng;

// create the generator without the anchor
let gen = rand_regex::Regex::compile(r".{4}.{4}", 100).unwrap();

// later filter the sampled result using a regex with the anchor
let filter_regex = regex::Regex::new(r"^.{4}\b.{4}$").unwrap();
let _sample = rand::thread_rng()
    .sample_iter::<String, _>(&gen)
    .filter(|s| filter_regex.is_match(s))
    .next()
    .unwrap();

Syntax(Box<Error>)

The input regex has a syntax error.

Examples

let gen = rand_regex::Regex::compile(r"(", 100);
assert!(match gen {
    Err(rand_regex::Error::Syntax(_)) => true,
    _ => false,
});

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Error

impl StructuralPartialEq for Error