actions/cargo-binstall
1
0
Fork 0
mirror of https://github.com/cargo-bins/cargo-binstall.git synced 2025-04-22 05:28:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document the library error types

Browse source
This commit is contained in:
Félix Saparelli 2022-05-31 21:15:52 +12:00
parent c0eaffb05d
commit f9e69503b0
No known key found for this signature in database
GPG key ID: B948C4BAE44FC474
1 changed files with 40 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
src/errors.rs
View file

@ -2,35 +2,54 @@ use miette::Diagnostic;
use thiserror::Error;
#[derive(Error, Diagnostic, Debug)]
#[diagnostic(url(docsrs))]
pub enum BinstallError {
/// The installation was cancelled by a user at a confirmation prompt.
#[error("installation cancelled by user")]
#[diagnostic(code(binstall::user_abort))]
UserAbort,
/// A generic I/O error.
#[error(transparent)]
#[diagnostic(code(binstall::io))]
Io(#[from] std::io::Error),
/// A URL is invalid.
///
/// This may be the result of a template in a Cargo manifest.
#[error(transparent)]
#[diagnostic(code(binstall::url_parse))]
UrlParse(#[from] url::ParseError),
/// A generic error from our HTTP client, reqwest.
///
/// Errors resulting from HTTP fetches are handled with [`BinstallError::Http`] instead.
#[error(transparent)]
#[diagnostic(code(binstall::reqwest))]
Reqwest(#[from] reqwest::Error),
/// A rendering error in a template.
#[error(transparent)]
#[diagnostic(code(binstall::template))]
Template(#[from] tinytemplate::error::Error),
/// An error while unzipping a file.
#[error(transparent)]
#[diagnostic(code(binstall::unzip))]
Unzip(#[from] zip::result::ZipError),
/// 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.
#[error(transparent)]
#[diagnostic(code(binstall::cargo_manifest))]
CargoManifest(#[from] cargo_toml::Error),
/// An error interacting with the crates.io API.
///
/// This could either be a "not found" or a server/transport error.
#[error("crates.io api error fetching crate information for '{crate_name}': {err}")]
#[diagnostic(code(binstall::crates_io_api))]
CratesIoApi {
@ -39,6 +58,10 @@ pub enum BinstallError {
err: crates_io_api::Error,
},
/// 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.
#[error("version string '{v}' is not semver: {err}")]
#[diagnostic(code(binstall::version::parse))]
VersionParse {
@ -47,6 +70,12 @@ pub enum BinstallError {
err: semver::Error,
},
/// A version requirement is not valid.
///
/// This is usually provided via the `--version` option.
///
/// Note that we use the [`semver`] crate, which parses Cargo version requirement syntax; they
/// may be slightly different from other semver requirements expressions implementations.
#[error("version requirement '{req}' is not semver: {err}")]
#[diagnostic(code(binstall::version::requirement))]
VersionReq {
@ -55,10 +84,17 @@ pub enum BinstallError {
err: semver::Error,
},
/// No available version matches the requirements.
///
/// This may be the case when using the `--version` option.
///
/// Note that using `--version 1.2.3` is interpreted as the requirement `^1.2.3` as per
/// Cargo.toml rules. If you want the exact version 1.2.3, use `--version '=1.2.3'`.
#[error("no version matching requirement '{req}'")]
#[diagnostic(code(binstall::version::mismatch))]
VersionMismatch { req: semver::VersionReq },
/// The crates.io API doesn't have manifest metadata for the given version.
#[error("no crate information available for '{crate_name}' version '{v}'")]
#[diagnostic(code(binstall::version::unavailable))]
VersionUnavailable {
@ -66,6 +102,10 @@ pub enum BinstallError {
v: semver::Version,
},
/// An HTTP request failed.
///
/// This includes both connection/transport failures and when the HTTP status of the response
/// is not as expected.
#[error("could not {method} {url}: {err}")]
#[diagnostic(code(binstall::http))]
Http {