Struct Update 

pub struct Update { /* private fields */ }

Wraps a ReleaseUpdate and restarts the process with the freshly installed binary after a successful update.

After update() returns Status::Updated, the process is re-executed using the new binary. A guard environment variable prevents restart loops: once the restarted process detects the guard, it returns UpToDate instead of restarting again.

Platform behavior

• Unix: Replaces the current process image via exec (never returns on success).
• Windows: Spawns the new binary and exits with the child’s status code.

Guard environment variable

Defaults to RESTART_GUARD but can be customized via UpdateBuilder::guard_env. The value is set to "1" during re-execution.

Implementations

impl Update

pub fn configure() -> UpdateBuilder

Initialize a new Update builder.

pub fn guard_env(&self) -> &str

The guard environment variable used to prevent restart loops.

Trait Implementations

impl ReleaseUpdate for Update

fn get_latest_release(&self) -> Result<Release>

Fetch details of the latest release from the backend

fn get_latest_releases(&self, current_version: &str) -> Result<Vec<Release>>

Fetch details of the latest release from the backend

fn get_release_version(&self, ver: &str) -> Result<Release>

Fetch details of the release matching the specified version

fn current_version(&self) -> String

Current version of binary being updated

fn target(&self) -> String

Target platform the update is being performed for

fn target_version(&self) -> Option<String>

Target version optionally specified for the update

fn bin_name(&self) -> String

Name of the binary being updated

fn bin_install_path(&self) -> PathBuf

Installation path for the binary being updated

fn bin_path_in_archive(&self) -> String

Path of the binary to be extracted from release package

fn show_download_progress(&self) -> bool

Flag indicating if progress information shall be output when downloading a release

fn show_output(&self) -> bool

Flag indicating if process informative messages shall be output

fn no_confirm(&self) -> bool

Flag indicating if the user shouldn’t be prompted to confirm an update

fn progress_template(&self) -> String

fn progress_chars(&self) -> String

fn auth_token(&self) -> Option<String>

Authorisation token for communicating with backend

fn update(&self) -> Result<Status>

Display release information and update the current binary to the latest release, pending confirmation from the user

fn update_extended(&self) -> Result<UpdateStatus>

Same as update, but returns UpdateStatus.

fn identifier(&self) -> Option<String>

Optional identifier of determining the asset among multiple matches

fn api_headers(&self, auth_token: &Option<String>) -> Result<HeaderMap, Error>

Construct a header with an authorisation entry if an auth token is provided