Trait self_github_update::update::ReleaseUpdate

pub trait ReleaseUpdate {
    // Required methods
    fn get_latest_release(&self) -> Result<Release>;
    fn get_release_version(&self, ver: &str) -> Result<Release>;
    fn current_version(&self) -> String;
    fn target(&self) -> String;
    fn target_version(&self) -> Option<String>;
    fn bin_name(&self) -> String;
    fn bin_install_path(&self) -> PathBuf;
    fn bin_path_in_archive(&self) -> PathBuf;
    fn show_download_progress(&self) -> bool;
    fn show_output(&self) -> bool;
    fn no_confirm(&self) -> bool;
    fn progress_template(&self) -> String;
    fn progress_chars(&self) -> String;
    fn auth_token(&self) -> Option<String>;

    // Provided methods
    fn identifier(&self) -> Option<String> { ... }
    fn api_headers(&self, auth_token: &Option<String>) -> Result<HeaderMap> { ... }
    fn update(&self) -> Result<Status> { ... }
    fn update_extended(&self) -> Result<UpdateStatus> { ... }
}

Updates to a specified or latest release

Required Methods

fn get_latest_release(&self) -> Result<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) -> PathBuf

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

Provided Methods

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

Optional identifier of determining the asset among multiple matches

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

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

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.

Implementors

impl ReleaseUpdate for Update