Enum BinstallError

#[non_exhaustive]
pub enum BinstallError {
    TaskJoinError(JoinError),
    UserAbort,
    InvalidSignature {
        crate_name: CompactString,
        package_name: CompactString,
    },
    MissingSignature(CompactString),
    UrlParse(ParseError),
    TemplateParseError(ParseError),
    FetchError(Box<FetchError>),
    Download(DownloadError),
    SubProcess {
        command: Box<str>,
        status: ExitStatus,
    },
    Io(Error),
    UnknownRegistryName(CompactString),
    RegistryError(Box<RegistryError>),
    CargoManifestPath,
    CargoManifest(Box<Error>),
    RegistryParseError(Box<InvalidRegistryError>),
    VersionParse(Box<VersionParseError>),
    SuperfluousVersionOption,
    UnspecifiedBinaries,
    NoViableTargets,
    BinFile(Error),
    CargoTomlMissingPackage(CompactString),
    DuplicateSourceFilePath {
        path: PathBuf,
    },
    NoFallbackToCargoInstall,
    InvalidPkgFmt(Box<InvalidPkgFmtError>),
    GhApiErr(Box<GhApiError>),
    TargetTripleParseError(Box<ParseError>),
    GitError(GitError),
    LoadManifestFromWSError(Box<Error>),
    CrateContext(Box<CrateContextError>),
    Errors(CrateErrors),
}

Error kinds emitted by cargo-binstall.

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.

TaskJoinError(JoinError)

Internal: a task could not be joined.

• Code: binstall::internal::task_join
• Exit: 17

UserAbort

The installation was cancelled by a user at a confirmation prompt, or user send a ctrl_c on all platforms or SIGINT, SIGHUP, SIGTERM or SIGQUIT on unix to the program.

• Code: binstall::user_abort
• Exit: 32

InvalidSignature

Package is not signed and policy requires it.

• Code: binstall::signature::invalid
• Exit: 40

Fields

crate_name: CompactString

package_name: CompactString

MissingSignature(CompactString)

Package is not signed and policy requires it.

• Code: binstall::signature::missing
• Exit: 41

UrlParse(ParseError)

A URL is invalid.

This may be the result of a template in a Cargo manifest.

• Code: binstall::url_parse
• Exit: 65

TemplateParseError(ParseError)

Failed to parse template.

• Code: binstall::template
• Exit: 67

FetchError(Box<FetchError>)

Failed to fetch pre-built binaries.

• Code: binstall::fetch
• Exit: 68

Download(DownloadError)

Failed to download or failed to decode the body.

• Code: binstall::download
• Exit: 68

SubProcess

A subprocess failed.

This is often about cargo-install calls.

• Code: binstall::subprocess
• Exit: 70

Fields

command: Box<str>

status: ExitStatus

Io(Error)

A generic I/O error.

• Code: binstall::io
• Exit: 74

UnknownRegistryName(CompactString)

Unknown registry name

• Code: binstall::cargo_registry
• Exit: 75

RegistryError(Box<RegistryError>)

An error interacting with the crates.io API.

This could either be a “not found” or a server/transport error.

• Code: binstall::cargo_registry
• Exit: 76

CargoManifestPath

The override path to the cargo manifest is invalid or cannot be resolved.

• Code: binstall::cargo_manifest_path
• Exit: 77

CargoManifest(Box<Error>)

A parsing or validation error in a cargo manifest.

This should be rare, as manifests are generally fetched from crates.io, which does its own validation upstream. The most common failure will therefore be for direct repository access and with the --manifest-path option.

• Code: binstall::cargo_manifest
• Exit: 78

RegistryParseError(Box<InvalidRegistryError>)

Failure to parse registry index url

• Code: binstall::cargo_registry
• Exit: 79

VersionParse(Box<VersionParseError>)

A version is not valid semver.

Note that we use the semver crate, which parses Cargo version syntax; this may be somewhat stricter or very slightly different from other semver implementations.

• Code: binstall::version::parse
• Exit: 80

SuperfluousVersionOption

The crate@version syntax was used at the same time as the –version option.

You can’t do that as it’s ambiguous which should apply.

• Code: binstall::conflict::version
• Exit: 84

UnspecifiedBinaries

No binaries were found for the crate.

When installing, either the binaries are specified in the crate’s Cargo.toml, or they’re inferred from the crate layout (e.g. src/main.rs or src/bins/name.rs). If no binaries are found through these methods, we can’t know what to install!

• Code: binstall::resolve::binaries
• Exit: 86

NoViableTargets

No viable targets were found.

When installing, we attempt to find which targets the host (your computer) supports, and discover builds for these targets from the remote binary source. This error occurs when we fail to discover the host’s target.

You should in this case specify –target manually.

• Code: binstall::targets::none_host
• Exit: 87

BinFile(Error)

Failed to find or install binaries.

• Code: binstall::bins
• Exit: 88

CargoTomlMissingPackage(CompactString)

Cargo.toml of the crate does not have section “Package”.

• Code: binstall::cargo_manifest
• Exit: 89

DuplicateSourceFilePath

bin-dir configuration provided generates duplicate source path.

• Code: binstall::cargo_manifest
• Exit: 90

Fields

path: PathBuf

NoFallbackToCargoInstall

Fallback to cargo-install is disabled.

• Code: binstall::no_fallback_to_cargo_install
• Exit: 94

InvalidPkgFmt(Box<InvalidPkgFmtError>)

Fallback to cargo-install is disabled.

• Code: binstall::invalid_pkg_fmt
• Exit: 95

GhApiErr(Box<GhApiError>)

Request to GitHub API failed

• Code: binstall::gh_api_failure
• Exit: 96

TargetTripleParseError(Box<ParseError>)

Failed to parse target triple

• Code: binstall::target_triple_parse_error
• Exit: 97

GitError(GitError)

Available on crate feature git only.

Failed to shallow clone git repository

• Code: binstall::git
• Exit: 98

LoadManifestFromWSError(Box<Error>)

Failed to load manifest from workspace

• Code: binstall::load_manifest_from_workspace
• Exit: 99

CrateContext(Box<CrateContextError>)

A wrapped error providing the context of which crate the error is about.

Errors(CrateErrors)

A wrapped error for failures of multiple crates when --continue-on-failure is specified.

Implementations

impl BinstallError

pub fn exit_code(&self) -> ExitCode

The recommended exit code for this error.

This will never output:

• 0 (success)
• 1 and 2 (catchall and shell)
• 16 (binstall errors not handled here)
• 64 (generic error)

pub fn crate_context(self, crate_name: impl Into<CompactString>) -> Self

Add crate context to the error

pub fn crate_errors(errors: Vec<Box<CrateContextError>>) -> Option<Self>

Trait Implementations

impl Debug for BinstallError

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

Formats the value using the given formatter.

impl Diagnostic for BinstallError

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 BinstallError

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

Formats the value using the given formatter.

impl Error for BinstallError

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<BinstallError> for Error

fn from(e: BinstallError) -> Error

Converts to this type from the input type.

impl From<Box<Error>> for BinstallError

fn from(source: Box<LoadManifestFromWSError>) -> Self

Converts to this type from the input type.

impl From<Box<InvalidRegistryError>> for BinstallError

fn from(source: Box<InvalidRegistryError>) -> Self

Converts to this type from the input type.

impl From<Box<RegistryError>> for BinstallError

fn from(source: Box<RegistryError>) -> Self

Converts to this type from the input type.

impl From<Box<VersionParseError>> for BinstallError

fn from(source: Box<VersionParseError>) -> Self

Converts to this type from the input type.

impl From<DownloadError> for BinstallError

fn from(source: DownloadError) -> Self

Converts to this type from the input type.

impl From<Error> for BinstallError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BinstallError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BinstallError

fn from(e: RemoteError) -> Self

Converts to this type from the input type.

impl From<Error> for BinstallError

fn from(e: CargoTomlError) -> Self

Converts to this type from the input type.

impl From<Error> for BinstallError

fn from(e: LoadManifestFromWSError) -> Self

Converts to this type from the input type.

impl From<FetchError> for BinstallError

fn from(e: FetchError) -> Self

Converts to this type from the input type.

impl From<GhApiError> for BinstallError

fn from(e: GhApiError) -> Self

Converts to this type from the input type.

impl From<GitError> for BinstallError

fn from(source: GitError) -> Self

Converts to this type from the input type.

impl From<InvalidPkgFmtError> for BinstallError

fn from(e: InvalidPkgFmtError) -> Self

Converts to this type from the input type.

impl From<InvalidRegistryError> for BinstallError

fn from(e: InvalidRegistryError) -> Self

Converts to this type from the input type.

impl From<JoinError> for BinstallError

fn from(source: JoinError) -> Self

Converts to this type from the input type.

impl From<ParseError> for BinstallError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseError> for BinstallError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseError> for BinstallError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<RegistryError> for BinstallError

fn from(e: RegistryError) -> Self

Converts to this type from the input type.

impl Termination for BinstallError

fn report(self) -> ExitCode

Is called to get the representation of the value as status code. This status code is returned to the operating system.