Struct tauri::updater::UpdateBuilder

pub struct UpdateBuilder<R: Runtime> { /* private fields */ }

This is supported on crate feature updater only.

An update check builder.

Implementations

impl<R: Runtime> UpdateBuilder<R>

pub fn skip_events(self) -> Self

Do not use the event system to emit information or listen to install the update.

pub fn target(self, target: impl Into<String>) -> Self

Set the target name. Represents the string that is looked up on the updater API or response JSON.

pub fn should_install<F: FnOnce(&str, &str) -> bool + Send + 'static>(
    self,
    f: F
) -> Self

Sets a closure that is invoked to compare the current version and the latest version returned by the updater server. The first argument is the current version, and the second one is the latest version.

The closure must return true if the update should be installed.

Examples

• Always install the version returned by the server:

tauri::Builder::default()
  .setup(|app| {
    tauri::updater::builder(app.handle()).should_install(|_current, _latest| true);
    Ok(())
  });

pub async fn check(self) -> Result<UpdateResponse<R>>

Check if an update is available.

Examples

tauri::Builder::default()
  .setup(|app| {
    let handle = app.handle();
    tauri::async_runtime::spawn(async move {
      match tauri::updater::builder(handle).check().await {
        Ok(update) => {}
        Err(error) => {}
      }
    });
    Ok(())
  });

Trait Implementations

impl<R: Debug + Runtime> Debug for UpdateBuilder<R>

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

Formats the value using the given formatter.