Expand description
In-app updates for Tauri applications.
Supported platforms: Windows, Linux and macOS.
§Cargo features
- zip (enabled by default): Adds support for compressed updater bundles from Tauri v1.
- rustls-tls (enabled by default): Enables TLS functionality provided by
rustls. - native-tls: Enables TLS functionality provided by
native-tls. - native-tls-vendored: Enables the
vendoredfeature ofnative-tls. - system-proxy (enabled by default): Use Windows and macOS system proxy settings automatically.
Structs§
- Builder
- Builder for the updater plugin.
- Config
- Updater configuration.
- Release
Manifest Platform - The update information of a single platform in the update manifest.
- Remote
Release - Information about a release returned by the remote update server.
- Update
- An update announced by the remote server, returned by
Updater::check. - Updater
- Checks the configured endpoints for an application update.
- Updater
Builder - Builder for an
Updaterinstance.
Enums§
- Error
- All errors that can occur while running the updater.
- Installer
- The kind of bundle the running application was installed from.
- Remote
Release Inner - The platform specific data of a
RemoteRelease, in either of the two supported shapes.
Traits§
- Updater
Ext - Extensions to
tauri::App,tauri::AppHandle,tauri::WebviewWindow,tauri::Webviewandtauri::Windowto access the updater APIs.
Functions§
- extract_
path_ from_ executable - Resolves the path the update must be installed to from the path of the application executable.
- target
- Gets the base target string used by the updater. If bundle type is available it
will be added to this string when selecting the download URL and signature.
tauri::utils::platform::bundle_typemethod is used to obtain current bundle type.
Type Aliases§
- OnBefore
Exit - Function executed right before the Windows installer is spawned and the app exits.
See
UpdaterBuilder::on_before_exit. - OnBefore
Request - Function that customizes the
reqwestclient builder used for the updater requests. SeeUpdaterBuilder::configure_client. - Result
- A
Resultalias whose error type is the updaterError. - Version
Comparator - Function that decides whether a remote release must be installed.