Struct PatternError 

pub struct PatternError { /* private fields */ }

An error returned when a pattern is not syntactically valid.

offset is a zero-based byte offset into the pattern, so a caller can point at the construct that failed. Display reads <message> at byte <offset>; the message is diagnostic text, while the offset is the stable part.

use ferralk_glob::{Pattern, PatternOptions};

let source = "src/[a-z/*.rs";
let error = Pattern::compile(source, PatternOptions::walker()).unwrap_err();
assert_eq!(error.offset(), 4); // the `[` that is never closed

// A byte offset is a column only for ASCII; count the characters before it
// to place a marker under any pattern.
let column = source[..error.offset()].chars().count();
let report = format!("{error}\n{source}\n{:>width$}", "^", width = column + 1);
assert!(report.ends_with("src/[a-z/*.rs\n    ^"));

Implementations

impl PatternError

pub const fn new(offset: usize, message: &'static str) -> Self

Builds an error for a pattern a layer above the matcher rejected.

Compilation produces these on its own; this exists for callers that impose rules the pattern language cannot express, such as a walker deciding that an absolute pattern cannot be rewritten for its root. Such a caller already returns PatternError, and a second error type in the same position would say nothing extra.

offset is a byte offset into the pattern the caller was given, and message describes the construct rather than the caller’s own state, so that Display reads the same as a compilation error.

pub const fn offset(&self) -> usize

Zero-based byte offset of the invalid construct.

pub const fn message(&self) -> &'static str

Description of the invalid construct.

This text is intended for diagnostics and is not a stable interface; use Self::offset for programmatic handling.

Trait Implementations

impl Clone for PatternError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PatternError

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

Formats the value using the given formatter.

impl Display for PatternError

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

Formats the value using the given formatter.

impl Eq for PatternError

impl Error for PatternError

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 PartialEq for PatternError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PatternError