Struct Update 

#[non_exhaustive]
pub struct Update { /* private fields */ }

Available on crate feature github only.

Updates to a specified or latest release distributed via GitHub

Implementations

impl Update

pub fn configure() -> UpdateBuilder

Initialize a new Update builder

impl Update

pub fn update(&self) -> Result<VersionStatus>

Display release information and update the current binary to the latest release, pending confirmation. Returns a VersionStatus. See ReleaseUpdate::update.

pub fn update_extended(&self) -> Result<ReleaseStatus>

Same as update but returns a ReleaseStatus with the full release details.

pub fn get_latest_release(&self) -> Result<Releases>

Fetch the single newest release (raw, unfiltered). See ReleaseUpdate::get_latest_release.

pub fn get_newer_releases(&self) -> Result<Releases>

Fetch the releases newer than the current version. See ReleaseUpdate::get_newer_releases.

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

Fetch details of the release matching ver. See ReleaseUpdate::get_release_version.

pub fn is_update_available(&self) -> Result<Option<Release>>

Whether a release newer than the current version is available, returning it if so.

A convenience over get_newer_releases: returns the newest strictly-newer Release, or None when already up to date.

Trait Implementations

impl AsyncReleaseUpdate for Update

Available on crate feature async only.

async fn get_latest_release_async(&self) -> Result<Releases>

Async sibling of ReleaseUpdate::get_latest_release: fetch the single newest release as a one-element Releases.

async fn get_newer_releases_async(&self) -> Result<Releases>

Async sibling of ReleaseUpdate::get_newer_releases: fetch the candidate releases as a Releases (newest-first, filtered to strictly-newer for the built-in backends).

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

Async sibling of ReleaseUpdate::get_release_version: fetch the release matching ver.

fn update_async( &self, ) -> impl Future<Output = Result<VersionStatus>> + Send + '_

where Self: Sized + Sync,

Async sibling of ReleaseUpdate::update: display release info and update the current binary to the latest release, returning a VersionStatus.

fn update_extended_async( &self, ) -> impl Future<Output = Result<ReleaseStatus>> + Send + '_

where Self: Sized + Sync,

Async sibling of ReleaseUpdate::update_extended: same as update_async but returns a ReleaseStatus.

impl Debug for Update

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

Formats the value using the given formatter.

impl ReleaseUpdate for Update

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

Fetch the single newest release from the backend.

fn get_newer_releases(&self) -> Result<Releases>

Fetch the candidate releases from the backend as a Releases (newest-first, carrying the configured current version).

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

Fetch details of the release matching the specified version

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

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

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

Same as update, but returns ReleaseStatus.

impl UpdateConfig for Update

fn api_headers(&self, _auth_token: Option<&str>) -> Result<HeaderMap>

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

fn current_version(&self) -> &str

Current version of binary being updated

fn target(&self) -> &str

Target platform the update is being performed for

fn release_tag(&self) -> Option<&str>

Release tag optionally specified for the update (set via release_tag)

fn asset_identifier(&self) -> Option<&str>

Optional identifier for determining the asset among multiple matches (set via asset_identifier)

fn bin_name(&self) -> &str

Name of the binary being updated

fn bin_install_path(&self) -> &Path

Installation path for the binary being updated

fn bin_path_in_archive(&self) -> &str

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) -> &str

Available on crate feature progress-bar only.

Message template to use if show_download_progress is set (see indicatif::ProgressStyle)

fn progress_chars(&self) -> &str

Available on crate feature progress-bar only.

Progress characters to use if show_download_progress is set (see indicatif::ProgressStyle)

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

Authorisation token for communicating with backend