Struct Update 

pub struct Update { /* private fields */ }

Wraps a ReleaseUpdate and throttles how often update checks run.

The underlying update check is skipped when one was already performed within throttle_window. The time of the last check is tracked via a throttle file in the system temp directory.

Throttle behavior

The throttle file is touched only after a successful update check. Failed checks do not reset the throttle window, allowing retries without waiting for the full window to elapse.

Implementations

impl Update

pub fn configure() -> UpdateBuilder

Initialize a new Update builder.

pub fn throttle_window(&self) -> Duration

The minimum time that must elapse between update checks.

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