tauri/crates/tauri-bundler/src/error.rs
kandrelczyk 232265c70e
feat: bundle type detection at runtime via binary patching (#13209)
* patch binary with bundle type info

* only patch if the updater is included

* fix linux warnings

* patch binary when updaer is configured

* patch binary with bundle type info

only patch if the updater is included

fix linux warnings

patch binary when updaer is configured

* fix formatting

* fix license header

* fix taplo error

* move __TAURI_BUNDLE_TYPE to utils

* export get_current_bundle_type

* macos fix

* cleanup, add api

* update change file

* fix windows

* fmt, fix rust version support

* fix macos

---------

Co-authored-by: Lucas Nogueira <lucas@tauri.app>
2025-07-07 12:08:00 -03:00

140 lines
4.5 KiB
Rust

// Copyright 2016-2019 Cargo-Bundle developers <https://github.com/burtonageo/cargo-bundle>
// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
use std::{io, num, path};
use thiserror::Error as DeriveError;
/// Errors returned by the bundler.
#[derive(Debug, DeriveError)]
#[non_exhaustive]
pub enum Error {
/// Error running tauri_utils API.
#[error("{0}")]
Resource(#[from] tauri_utils::Error),
/// Bundler error.
#[error("{0:#}")]
BundlerError(#[from] anyhow::Error),
/// I/O error.
#[error("`{0}`")]
IoError(#[from] io::Error),
/// Image error.
#[error("`{0}`")]
ImageError(#[from] image::ImageError),
/// Error walking directory.
#[error("`{0}`")]
WalkdirError(#[from] walkdir::Error),
/// Strip prefix error.
#[error("`{0}`")]
StripError(#[from] path::StripPrefixError),
/// Number parse error.
#[error("`{0}`")]
ConvertError(#[from] num::TryFromIntError),
/// Zip error.
#[error("`{0}`")]
ZipError(#[from] zip::result::ZipError),
/// Hex error.
#[error("`{0}`")]
HexError(#[from] hex::FromHexError),
/// Handlebars template error.
#[error("`{0}`")]
HandleBarsError(#[from] handlebars::RenderError),
/// JSON error.
#[error("`{0}`")]
JsonError(#[from] serde_json::error::Error),
/// Regex error.
#[cfg(any(target_os = "macos", windows))]
#[error("`{0}`")]
RegexError(#[from] regex::Error),
/// Failed to perform HTTP request.
#[error("`{0}`")]
HttpError(#[from] Box<ureq::Error>),
/// Invalid glob pattern.
#[cfg(windows)]
#[error("{0}")]
GlobPattern(#[from] glob::PatternError),
/// Failed to use glob pattern.
#[cfg(windows)]
#[error("`{0}`")]
Glob(#[from] glob::GlobError),
/// Failed to parse the URL
#[error("`{0}`")]
UrlParse(#[from] url::ParseError),
/// Failed to validate downloaded file hash.
#[error("hash mismatch of downloaded file")]
HashError,
/// Failed to parse binary
#[error("Binary parse error: `{0}`")]
BinaryParseError(#[from] goblin::error::Error),
/// Package type is not supported by target platform
#[error("Wrong package type {0} for platform {1}")]
InvalidPackageType(String, String),
/// Bundle type symbol missing in binary
#[error("__TAURI_BUNDLE_TYPE variable not found in binary. Make sure tauri crate and tauri-cli are up to date")]
MissingBundleTypeVar,
/// Failed to write binary file changed
#[error("Failed to write binary file changes: `{0}`")]
BinaryWriteError(String),
/// Invalid offset while patching binary file
#[error("Invalid offset while patching binary file")]
BinaryOffsetOutOfRange,
/// Unsupported architecture.
#[error("Architecture Error: `{0}`")]
ArchError(String),
/// Couldn't find icons.
#[error("Could not find Icon paths. Please make sure they exist in the tauri config JSON file")]
IconPathError,
/// Couldn't find background file.
#[error("Could not find background file. Make sure it exists in the tauri config JSON file and extension is png/jpg/gif")]
BackgroundPathError,
/// Error on path util operation.
#[error("Path Error:`{0}`")]
PathUtilError(String),
/// Error on shell script.
#[error("Shell Scripting Error:`{0}`")]
ShellScriptError(String),
/// Generic error.
#[error("`{0}`")]
GenericError(String),
/// No bundled project found for the updater.
#[error("Unable to find a bundled project for the updater")]
UnableToFindProject,
/// String is not UTF-8.
#[error("string is not UTF-8")]
Utf8(#[from] std::str::Utf8Error),
/// Windows SignTool not found.
#[error("SignTool not found")]
SignToolNotFound,
/// Failed to open Windows registry.
#[error("failed to open registry {0}")]
OpenRegistry(String),
/// Failed to get registry value.
#[error("failed to get {0} value on registry")]
GetRegistryValue(String),
/// Failed to enumerate registry keys.
#[error("failed to enumerate registry keys")]
FailedToEnumerateRegKeys,
/// Unsupported OS bitness.
#[error("unsupported OS bitness")]
UnsupportedBitness,
/// Failed to sign application.
#[error("failed to sign app: {0}")]
Sign(String),
/// time error.
#[cfg(target_os = "macos")]
#[error("`{0}`")]
TimeError(#[from] time::error::Error),
/// Plist error.
#[cfg(target_os = "macos")]
#[error(transparent)]
Plist(#[from] plist::Error),
/// Rpm error.
#[cfg(target_os = "linux")]
#[error("{0}")]
RpmError(#[from] rpm::Error),
}
/// Convenient type alias of Result type.
pub type Result<T> = std::result::Result<T, Error>;