Struct wax::BuildError

pub struct BuildError { /* private fields */ }

Describes errors that occur when building a Pattern from a glob expression.

Glob expressions may fail to build if they cannot be parsed, violate rules, or cannot be compiled. Parsing errors occur when a glob expression has invalid syntax. Patterns must also follow rules as described in the repository documentation, which are designed to avoid nonsense expressions and ambiguity. Lastly, compilation errors occur only if the size of the compiled program is too large (all other compilation errors are considered internal bugs and will panic).

When the miette feature is enabled, this and other error types implement the Diagnostic trait. Due to a technical limitation, this may not be properly annotated in API documentation.

Implementations

impl BuildError

pub fn locations(&self) -> impl Iterator<Item = &dyn LocatedError>

Gets LocatedErrors detailing the errors within a glob expression.

This function returns an Iterator over the LocatedErrors that detail where and why an error occurred when the error has associated Spans within a glob expression. For errors with no such associated information, the Iterator yields no items, such as compilation errors.

Examples

LocatedErrors can be used to provide information to users about which parts of a glob expression are associated with an error.

use wax::Glob;

// This glob expression violates rules. The error handling code prints details about the
// alternative where the violation occurred.
let expression = "**/{foo,**/bar,baz}";
match Glob::new(expression) {
    Ok(glob) => {
        // ...
    },
    Err(error) => {
        eprintln!("{}", error);
        for error in error.locations() {
            let (start, n) = error.span();
            let fragment = &expression[start..][..n];
            eprintln!("in sub-expression `{}`: {}", fragment, error);
        }
    },
}

Trait Implementations

impl Debug for BuildError

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

Formats the value using the given formatter.

impl Diagnostic for BuildError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for BuildError

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

Formats the value using the given formatter.

impl Error for BuildError

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 From<BuildError> for GlobError

fn from(error: BuildError) -> Self

Converts to this type from the input type.

impl From<Infallible> for BuildError

fn from(_: Infallible) -> Self

Converts to this type from the input type.