Enum Error 

#[non_exhaustive]
pub enum Error {
    Io {
        path: PathBuf,
        source: Error,
    },
    EmptyDirs,
    Toml {
        path: PathBuf,
        source: Error,
    },
    MissingSection(PathBuf),
    InvalidSection,
    UnknownConvention {
        context: String,
        value: String,
    },
}

All errors that convention-lint can produce.

This type is #[non_exhaustive] so that new variants can be added in minor versions without breaking downstream match expressions.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Io

The manifest file could not be opened or read.

Fields

path: PathBuf

Path to the manifest that could not be read.

source: Error

Underlying I/O error.

EmptyDirs

The dirs list in a check rule is empty.

Toml

The manifest file contains invalid TOML.

Fields

path: PathBuf

Path to the manifest that could not be parsed.

source: Error

Underlying TOML parse error.

MissingSection(PathBuf)

The [workspace.metadata.convention-lint] or [package.metadata.convention-lint] section is absent from the manifest.

InvalidSection

The metadata section exists but is not a TOML table.

UnknownConvention

The convention string is not one of the recognised identifiers.

Fields

context: String

The file extensions (e.g. *.idl) that the unrecognised convention was configured for.

value: String

The unrecognised convention string supplied by the user.

Trait Implementations

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, __formatter: &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.