Enum axoproject::errors::AxoprojectError

#[non_exhaustive]
pub enum AxoprojectError {
    Axoasset(AxoassetError),
    CargoMetadata(Error),
    ParseChangelog(Error),
    ParseCargoToml {
        source: SourceFile,
        span: Option<SourceSpan>,
        details: TomlError,
    },
    NamelessNpmPackage {
        manifest: Utf8PathBuf,
    },
    BuildInfoParse {
        manifest_path: Utf8PathBuf,
        details: Error,
    },
    InconsistentRepositoryKey {
        file1: Utf8PathBuf,
        url1: String,
        file2: Utf8PathBuf,
        url2: String,
    },
    AutoIncludeSearch {
        dir: Utf8PathBuf,
        details: Error,
    },
    UnknownRepoStyle {
        url: String,
    },
    RepoParseError {
        repo: String,
    },
    UrlParseError(ParseError),
    NotGitHubError {
        url: String,
    },
    ChangelogVersionNotFound {
        path: Utf8PathBuf,
        version: Version,
    },
}

An Error/Diagnostic returned by Axoproject

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.

Axoasset(AxoassetError)

Axoasset returned an error (I/O error)

CargoMetadata(Error)

An error occured in guppy/cargo-metadata when trying to find a cargo project

ParseChangelog(Error)

An error occured in parse_changelog

ParseCargoToml

An error parsing a Cargo.toml

Fields

source: SourceFile

The toml file

span: Option<SourceSpan>

Where we found an issue

details: TomlError

The underlying issue

NamelessNpmPackage

We found a package.json but it didn’t have “name” set

Fields

manifest: Utf8PathBuf

path to the package.json

BuildInfoParse

We tried to get the bins from a package.json but something went wrong

Fields

manifest_path: Utf8PathBuf

Path to the package.json

details: Error

underlying error

InconsistentRepositoryKey

Your workspace gave several different values for “repository”

Fields

file1: Utf8PathBuf

Path to the first manifest

url1: String

value the first manifest had set

file2: Utf8PathBuf

Path to the second manifest

url2: String

value the second manifest had set

AutoIncludeSearch

An error that occured while trying to find READMEs and whatnot in your project dir

Fields

dir: Utf8PathBuf

path to the dir we were searching

details: Error

underlying error

UnknownRepoStyle

An error that occurred while trying to parse a repository string

Fields

url: String

URL to the repository

RepoParseError

An error that occurred because a repository string could not be parsed for a specific reason

Fields

repo: String

URL to the repository

UrlParseError(ParseError)

An error that occurred when parsing a repository string

NotGitHubError

An error returned when a non-GitHub URL is parsed

Fields

url: String

URL to the repository

ChangelogVersionNotFound

We searched a changelog file but found no result

Fields

path: Utf8PathBuf

Path of the file

version: Version

Version we were looking for

Trait Implementations

impl Debug for AxoprojectError

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

Formats the value using the given formatter.

impl Diagnostic for AxoprojectError

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 severity(&self) -> Option<Severity>

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

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

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

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 url(&self) -> Option<Box<dyn Display + '_>>

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

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

The cause of the error.

impl Display for AxoprojectError

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

Formats the value using the given formatter.

impl Error for AxoprojectError

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<AxoassetError> for AxoprojectError

fn from(source: AxoassetError) -> Self

Converts to this type from the input type.

impl From<Error> for AxoprojectError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AxoprojectError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for AxoprojectError

fn from(source: ParseError) -> Self

Converts to this type from the input type.