Struct Updater 

pub struct Updater {
    pub app_name: String,
    pub current_version: Version,
    pub proxy: Option<Url>,
    pub github_client: GitHubClient,
    pub headers: HeaderMap,
    pub extract_path: PathBuf,
    pub timeout: Option<Duration>,
    pub installer_args: Vec<OsString>,
    pub current_exe_args: Vec<OsString>,
    pub latest_release: Option<GitHubRelease>,
    pub proper_asset: Option<GitHubAsset>,
}

Updater instance capable of checking, downloading and installing updates.

Fields

app_name: String

current_version: Version

proxy: Option<Url>

github_client: GitHubClient

headers: HeaderMap

extract_path: PathBuf

timeout: Option<Duration>

installer_args: Vec<OsString>

current_exe_args: Vec<OsString>

latest_release: Option<GitHubRelease>

proper_asset: Option<GitHubAsset>

Implementations

impl Updater

pub async fn latest_release(&self) -> Result<GitHubRelease>

Fetch the latest GitHub release and convert it into a simplified structure.

pub fn latest_version(&self) -> Option<Version>

The version of the latest release if it has been previously cached on this instance.

pub fn asset_size(&self) -> Option<u64>

The size in bytes of the asset selected for this platform, if already resolved.

pub async fn proper_asset(&self) -> Result<GitHubAsset>

Resolve the proper asset for the current OS/arch.

pub async fn check(&self) -> Result<Option<Updater>>

Check for a newer version. Returns Ok(Some(Updater)) configured with the selected asset if an update is available, or Ok(None) if up-to-date.

pub async fn update<C: FnMut(usize)>(&self, on_chunk: C) -> Result<bool>

Check for updates and download/install if available.

This is a convenience method that combines Updater::check() and Updater::download_and_install(). Returns Ok(true) if an update was found and installed, Ok(false) if no update was needed.

impl Updater

pub async fn download<C: FnMut(usize)>(&self, on_chunk: C) -> Result<Vec<u8>>

Downloads the updater package, verifies it then return it as bytes.

Use Updater::install to install it

pub fn install(&self, bytes: impl AsRef<[u8]>) -> Result<()>

Installs the updater package downloaded by Updater::download

pub fn relaunch(&self) -> Result<()>

pub async fn download_and_install<C: FnMut(usize)>( &self, on_chunk: C, ) -> Result<()>

Downloads and installs the updater package

Trait Implementations

impl Clone for Updater

fn clone(&self) -> Updater

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Updater

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

Formats the value using the given formatter.