Enum DistError

pub enum DistError {
    Io(Error),
    Asset(AxoassetError),
    Cmd(AxoprocessError),
    Gazenot(GazenotError),
    Project(ProjectError),
    FromUtf8Error(FromUtf8Error),
    Goblin(Error),
    FromPathBufError(FromPathBufError),
    DialoguerError(Error),
    AxotagError(TagError),
    ParseIntError(ParseIntError),
    TripleError(ParseError),
    Jinja {
        source: String,
        span: Option<SourceSpan>,
        backtrace: JinjaErrorWithBacktrace,
    },
    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 {
        manifest_list: String,
    },
    CantEnableGithubUrlNotGithub {
        inner: AxoprojectError,
    },
    ScopeMustBeLowercase {
        scope: String,
    },
    InstallPathInvalid {
        path: String,
    },
    InstallPathEnvSlash {
        path: String,
    },
    InstallPathHomeSubdir {
        path: String,
    },
    PreciseImpossible {
        packages: Vec<Utf8PathBuf>,
    },
    MismatchedTaps {
        packages: Vec<Utf8PathBuf>,
    },
    MismatchedPublishers {
        packages: Vec<Utf8PathBuf>,
    },
    MismatchedPrereleases,
    NothingToRelease {
        help: String,
    },
    TooManyUnrelatedApps {
        help: String,
    },
    CheckFileMismatch {
        file: SourceFile,
        diff: String,
    },
    ContradictoryGenerateModes {
        generate_mode: GenerateMode,
    },
    MultiPackage {
        artifact_name: ArtifactId,
        spec1: String,
        spec2: String,
    },
    NoPackage {
        artifact_name: ArtifactId,
    },
    MissingWixGuids {
        manifest_path: Utf8PathBuf,
        keys: &'static [&'static str],
    },
    UnrecognizedJobStyle {
        style: String,
    },
    UnrecognizedHostingStyle {
        style: String,
    },
    NoGitHubHosting {},
    UnrecognizedCiStyle {
        style: String,
    },
    UnrecognizedLibraryStyle {
        style: String,
    },
    LinkageCheckInvalidOS {
        host: String,
        target: TripleName,
    },
    LinkageCheckUnsupportedBinary,
    EnvParseError {
        line: String,
    },
    GitArchiveError {},
    GitSubmoduleCommitError {
        path: String,
    },
    ToolMissing {
        tool: String,
    },
    EnvToolsMissing {
        tools: Vec<String>,
    },
    NoAxoupdaterForTarget {
        target: String,
    },
    AxoupdaterReleaseCheckFailed {},
    UnrecognizedCompression {
        extension: String,
    },
    MissingBinaries {
        pkg_name: String,
        bin_name: String,
    },
    UpdateFailed {},
    UpdateNotInWorkspace {
        cause: ProjectError,
    },
    IncompatibleInstallPathConfiguration,
    CliMissingTargets {
        host_target: TripleName,
    },
    NeedsInit,
    MismatchedDistVersion {
        config_version: String,
        running_version: String,
    },
    FailedCargoVersion,
    GithubRepoPairParse {
        pair: String,
    },
    GithubUnknownPermission {
        levels: Vec<String>,
    },
    UnrecognizedTarget {
        target: TripleName,
    },
    EmptyInstaller {},
    GithubBuildSetupNotFound {
        details: AxoassetError,
    },
    GithubBuildSetupParse {
        details: AxoassetError,
    },
    GithubBuildSetupNotValid {
        file_path: Utf8PathBuf,
        message: String,
    },
    UnusedMetadata {
        manifest_path: Utf8PathBuf,
        dist_manifest_path: Utf8PathBuf,
    },
    SusBuildCommand {
        manifest: Utf8PathBuf,
        command: String,
    },
    NoDistScript {
        manifest: Utf8PathBuf,
    },
    UnsupportedCrossCompile {
        host: Triple,
        target: Triple,
        details: String,
    },
    CannotDoCargoAuditableAndCrossCompile {
        host: Triple,
        target: Triple,
    },
    CargoOnlyBuildOptions {
        options: Vec<String>,
    },
    NoBuildCommand {
        manifest: Utf8PathBuf,
    },
    UnexpectedBuildCommand {
        manifest: Utf8PathBuf,
    },
    CertificateDecodeError {},
    MacPkgConfigMissing {},
    MacPkgBundleIdentifierMissing {},
    AxoupdaterTooOld {
        package_name: String,
        source_name: String,
        minimum: Version,
        your_version: Version,
    },
}

Errors dist can have

Variants

Io(Error)

random i/o error

Asset(AxoassetError)

random axoasset error

Cmd(AxoprocessError)

random axoprocess error

Gazenot(GazenotError)

random gazenot error

Project(ProjectError)

random gazenot error

FromUtf8Error(FromUtf8Error)

random string error

Goblin(Error)

random i/o error

FromPathBufError(FromPathBufError)

random camino conversion error

DialoguerError(Error)

random dialoguer error

AxotagError(TagError)

random axotag error

ParseIntError(ParseIntError)

random parseint error

TripleError(ParseError)

random triple parse error

Jinja

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

Fields

source: String

The SourceFile we were try to parse

span: Option<SourceSpan>

The range the error was found on

backtrace: JinjaErrorWithBacktrace

Details of the error

Wix

Error from (cargo-)wix

Fields

msi: String

The msi we were trying to build

details: Error

The underlying wix error

WixInit

Error from (cargo-)wix init

Fields

package: String

The package

details: Error

The underlying wix error

CargoTomlParse

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

Fields

manifest_path: Utf8PathBuf

path to file

cause: Error

Inner error

NoUpdateVersion

User declined to update dist, refuse to make progress

Fields

project_version: Version

Version the config had

running_version: Version

Version they’re running

CantEnableGithubUrlInconsistent

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

Fields

inner: AxoprojectError

inner error that caught this

CantEnableGithubNoUrl

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

Fields

manifest_list: String

List of manifests to change

CantEnableGithubUrlNotGithub

We got a repository URL but couldn’t interpret it as a GitHub repo

Fields

inner: AxoprojectError

inner error that caught this

ScopeMustBeLowercase

User supplied an illegal npm scope

Fields

scope: String

The incorrectly-formatted scope

InstallPathInvalid

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!

Fields

path: String

The full value passed to install-path

InstallPathEnvSlash

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!

Fields

path: String

The full value passed to install-path

InstallPathHomeSubdir

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!

Fields

path: String

The full value passed to install-path

PreciseImpossible

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

Fields

packages: Vec<Utf8PathBuf>

paths of problem manifests

MismatchedTaps

packages disagreed on homebrew taps

Fields

packages: Vec<Utf8PathBuf>

paths of problem manifests

MismatchedPublishers

packages disagreed on publishers

Fields

packages: Vec<Utf8PathBuf>

paths of problem manifests

MismatchedPrereleases

publishers disagreed on prereleases

NothingToRelease

parse_tag concluded there was nothing to release

Fields

help: String

full help printout (very dynamic)

TooManyUnrelatedApps

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

Fields

help: String

full help printout (very dynamic)

CheckFileMismatch

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

Fields

file: SourceFile

The file whose contents differ

diff: String

The diff

ContradictoryGenerateModes

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

Fields

generate_mode: GenerateMode

The problematic mode

MultiPackage

msi/pkg with too many packages

Fields

artifact_name: ArtifactId

Name of the artifact

spec1: String

One of the packages

spec2: String

A different package

NoPackage

msi/pkg with too few packages

Fields

artifact_name: ArtifactId

Name of the msi

MissingWixGuids

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

Fields

manifest_path: Utf8PathBuf

The Cargo.toml missing them

keys: &'static [&'static str]

The missing keys

UnrecognizedJobStyle

unrecognized job style

Fields

style: String

value provided

UnrecognizedHostingStyle

unrecognized hosting style

Fields

style: String

value provided

NoGitHubHosting

unrecognized hosting style

UnrecognizedCiStyle

unrecognized ci style

Fields

style: String

value provided

UnrecognizedLibraryStyle

unrecognized library style

Fields

style: String

value provided

LinkageCheckInvalidOS

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

Fields

host: String

The OS the check was run on

target: TripleName

The OS being checked

LinkageCheckUnsupportedBinary

Linkage report can’t be run for this target

EnvParseError

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

Fields

line: String

The line of text that couldn’t be parsed

GitArchiveError

An error running git archive

GitSubmoduleCommitError

An error running git -C path rev-parse HEAD

Fields

path: String

The path we failed to fetch

ToolMissing

A required tool is missing

Fields

tool: String

the name of the missing tool

EnvToolsMissing

One or more required tools are missing.

Fields

tools: Vec<String>

the names of the missing tools

NoAxoupdaterForTarget

Unknown target requested

Fields

target: String

The target triple being built for

AxoupdaterReleaseCheckFailed

reqwest returned non-2xx/404 when checking axoupdater releases

UnrecognizedCompression

Failed to determine how to uncompress something

Fields

extension: String

The file extension of the unrecognized file

MissingBinaries

Binaries were missing

Fields

pkg_name: String

Name of package

bin_name: String

Name of binary

UpdateFailed

Error during dist selfupdate

UpdateNotInWorkspace

Trying to run dist selfupdate in a random dir

Fields

cause: ProjectError

The report about the missing workspace

IncompatibleInstallPathConfiguration

Trying to include CargoHome with other install paths

CliMissingTargets

Passed –artifacts but no –target

Fields

host_target: TripleName

Current host target

NeedsInit

Workspace isn’t init

MismatchedDistVersion

Running different version from config

Fields

config_version: String

config version

running_version: String

running version

FailedCargoVersion

Failed to make sense of ‘cargo -vV’

GithubRepoPairParse

Failed to parse Github repo pair

Fields

pair: String

The input

GithubUnknownPermission

Unknown permission specified in GitHub Actions config

Fields

levels: Vec<String>

The input

UnrecognizedTarget

An unknown target was found

Fields

target: TripleName

The target in question

EmptyInstaller

Installers requested despite having nothing to install

GithubBuildSetupNotFound

Configuration value for github-build-setup defined but not found

Fields

details: AxoassetError

Inner i/o error with file path

GithubBuildSetupParse

Configuration value for github-build-setup defined but not found

Fields

details: AxoassetError

Inner parse error with path and spans

GithubBuildSetupNotValid

github-build-setup file contents are invalid

Fields

file_path: Utf8PathBuf

The value from the configuration file

message: String

Error message details

UnusedMetadata

Something has metadata.dist but shouldn’t

Fields

manifest_path: Utf8PathBuf

The manifest that had the metadata.dist

dist_manifest_path: Utf8PathBuf

The dist.toml/dist-workspace.toml that means it’s ignored

SusBuildCommand

Build command looks like they put args in same string as command

Fields

manifest: Utf8PathBuf

path to manifest

command: String

what the command was

NoDistScript

missing “dist” script in a package.json

Fields

manifest: Utf8PathBuf

path to package.json

UnsupportedCrossCompile

Unsupported cross-compilation host/target combination

Fields

host: Triple

The host system

target: Triple

The target system

details: String

Additional details about why this combination is unsupported

CannotDoCargoAuditableAndCrossCompile

Cannot use cross-compilation with cargo-auditable

Fields

host: Triple

The host system

target: Triple

The target system

CargoOnlyBuildOptions

Generic build with Cargo-only build options

Fields

options: Vec<String>

The names of the invalid options

NoBuildCommand

missing “build-command” for a package that needs one

Fields

manifest: Utf8PathBuf

path to manifest

UnexpectedBuildCommand

cargo package with build-command

Fields

manifest: Utf8PathBuf

path to manifest

CertificateDecodeError

Failure to decode base64-encoded certificate

MacPkgConfigMissing

Missing configuration for a .pkg

MacPkgBundleIdentifierMissing

User left identifier empty in init

AxoupdaterTooOld

Project depends on a too-old axoupdater

Fields

package_name: String

Name of the package

source_name: String

The package that depended on axoupdater

minimum: Version

Minimum supported version

your_version: Version

Version the project uses

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)>

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 From<AxoassetError> for DistError

fn from(source: AxoassetError) -> Self

Converts to this type from the input type.

impl From<AxoprocessError> for DistError

fn from(source: AxoprocessError) -> 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(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<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<ParseError> for DistError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for DistError

fn from(source: ParseIntError) -> Self

Converts to this type from the input type.

impl From<ProjectError> for DistError

fn from(source: ProjectError) -> 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.