Enum cargo_dist::errors::DistError

pub enum DistError {
    Io(Error),
    Asset(AxoassetError),
    Gazenot(GazenotError),
    FromUtf8Error(FromUtf8Error),
    Jinja {
        source: String,
        span: Option<SourceSpan>,
        details: Error,
    },
    Wix {
        msi: String,
        details: Error,
    },
    WixInit {
        package: String,
        details: Error,
    },
    CargoTomlParse {
        manifest_path: Utf8PathBuf,
        cause: Error,
    },
    NoUpdateVersion {
        project_version: Version,
        running_version: Version,
    },
    CantEnableGithubUrlInconsistent {
        inner: AxoprojectError,
    },
    CantEnableGithubNoUrl,
    MustEnableTarGz,
    InstallPathInvalid {
        path: String,
    },
    InstallPathEnvSlash {
        path: String,
    },
    InstallPathHomeSubdir {
        path: String,
    },
    PreciseImpossible {
        packages: Vec<String>,
    },
    NothingToRelease {
        help: String,
    },
    TooManyUnrelatedApps {
        help: String,
    },
    CheckFileMismatch {
        file: SourceFile,
        diff: String,
    },
    ContradictoryGenerateModes {
        generate_mode: GenerateMode,
    },
    MultiPackageMsi {
        artifact_name: String,
        spec1: String,
        spec2: String,
    },
    NoPackageMsi {
        artifact_name: String,
    },
    MissingWixGuids {
        manifest_path: Utf8PathBuf,
        keys: &'static [&'static str],
    },
    UnrecognizedStyle {
        style: String,
    },
    LinkageCheckInvalidOS {
        host: String,
        target: String,
    },
    LinkageCheckUnsupportedBinary {},
    Goblin(Error),
    FromPathBufError(FromPathBufError),
    EnvParseError {
        line: String,
    },
    DialoguerError(Error),
    AxotagError(TagError),
    ProjectMissing {
        sources: Vec<AxoprojectError>,
    },
    GitArchiveError {},
    ToolMissing {
        tool: String,
    },
}

Errors cargo-dist can have

Variants

Io(Error)

random i/o error

Asset(AxoassetError)

random axoasset error

Gazenot(GazenotError)

random gazenot error

FromUtf8Error(FromUtf8Error)

random string error

Jinja

Fields

source: String

The SourceFile we were try to parse

span: Option<SourceSpan>

The range the error was found on

details: Error

Details of the error

A problem with a jinja template, which is always a cargo-dist bug

Wix

Fields

msi: String

The msi we were trying to build

details: Error

The underyling wix error

Error from (cargo-)wix

WixInit

Fields

package: String

The package

details: Error

The underlying wix error

Error from (cargo-)wix init

CargoTomlParse

Fields

manifest_path: Utf8PathBuf

path to file

cause: Error

Inner error

Error parsing metadata in Cargo.toml (json because it’s from cargo-metadata)

NoUpdateVersion

Fields

project_version: Version

Version the config had

running_version: Version

Version they’re running

User declined to update cargo-dist, refuse to make progress

CantEnableGithubUrlInconsistent

Fields

inner: AxoprojectError

inner error that caught this

User tried to enable Github CI support but had inconsistent urls for the repo

CantEnableGithubNoUrl

User tried to enable Github CI support but no url for the repo

MustEnableTarGz

User declined to force tar.gz with npm

InstallPathInvalid

Fields

path: String

The full value passed to install-path

Completely unknown format to install-path

NOTE: we can’t use diagnostic(help) here because this will get crammed into a serde_json error, reducing it to a String. So we inline the help!

InstallPathEnvSlash

Fields

path: String

The full value passed to install-path

Being pedantic about the env-var mode of install-path to be consistent

NOTE: we can’t use diagnostic(help) here because this will get crammed into a serde_json error, reducing it to a String. So we inline the help!

InstallPathHomeSubdir

Fields

path: String

The full value passed to install-path

Being pedantic about the home mode of install-path to be consistent

NOTE: we can’t use diagnostic(help) here because this will get crammed into a serde_json error, reducing it to a String. So we inline the help!

PreciseImpossible

Fields

packages: Vec<String>

names of problem packages

Use explicitly requested workspace builds, but had packages with custom feature settings

NothingToRelease

Fields

help: String

full help printout (very dynamic)

parse_tag concluded there was nothing to release

TooManyUnrelatedApps

Fields

help: String

full help printout (very dynamic)

parse_tag concluded there are too many unrelated things for a single tag

CheckFileMismatch

Fields

file: SourceFile

The file whose contents differ

diff: String

The diff

Not an error; indicates that a file’s contents differ via –check

ContradictoryGenerateModes

Fields

generate_mode: GenerateMode

The problematic mode

cargo dist generate was passed an explicit GenerateMode but the config in their Cargo.toml has that mode set to allow-dirty, a contradiction!

MultiPackageMsi

Fields

artifact_name: String

Name of the msi

spec1: String

One of the pacakges

spec2: String

A different package

msi with too many packages

NoPackageMsi

Fields

artifact_name: String

Name of the msi

msi with too few packages

MissingWixGuids

Fields

manifest_path: Utf8PathBuf

The Cargo.toml missing them

keys: &'static [&'static str]

The missing keys

These GUIDs for msi’s are required and enforced by cargo dist generate --check

UnrecognizedStyle

Fields

style: String

Name of the msi

unrecognized style

LinkageCheckInvalidOS

Fields

host: String

The OS the check was run on

target: String

The OS being checked

Linkage report can’t be run for this combination of OS and target

LinkageCheckUnsupportedBinary

Linkage report can’t be run for this target

Goblin(Error)

random i/o error

FromPathBufError(FromPathBufError)

random camino conversion error

EnvParseError

Fields

line: String

The line of text that couldn’t be parsed

Error parsing a string containing an environment variable in VAR=value syntax

DialoguerError(Error)

random dialoguer error

AxotagError(TagError)

random axotag error

ProjectMissing

Fields

sources: Vec<AxoprojectError>

axoproject’s error for the unidentified project

No workspace found from axoproject

GitArchiveError

An error running git archive

ToolMissing

Fields

tool: String

the name of the missing tool

A required tool is missing

Trait Implementations

impl Debug for DistError

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

Formats the value using the given formatter.

impl Diagnostic for DistError

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 DistError

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

Formats the value using the given formatter.

impl Error for DistError

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 DistError

fn from(source: AxoassetError) -> Self

Converts to this type from the input type.

impl From<Error> for DistError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DistError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DistError

fn from(details: Error) -> Self

Converts to this type from the input type.

impl From<Error> for DistError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromPathBufError> for DistError

fn from(source: FromPathBufError) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for DistError

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<GazenotError> for DistError

fn from(source: GazenotError) -> Self

Converts to this type from the input type.

impl From<TagError> for DistError

fn from(source: TagError) -> Self

Converts to this type from the input type.