corundum-framework-update 0.3.0

Find newer GitHub releases of an app's binary, and replace it with one
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Newer releases of an app's binary: finding them, and installing one.
//!
//! A binary's releases are a GitHub repository's, tagged `<prefix><version>`
//! ([`ReleaseSource`]). [`latest_release`] finds the newest; the app server asks it once a
//! day and shows the answer in `status`. The `update` command (`UpdateArgs`) goes one step
//! further and replaces the running executable with the release's, but only:
//!
//! - with a newer version: never a downgrade;
//! - with the asset for this platform, `<asset>-<os>-<arch>[.exe]`, downloaded over HTTPS
//!   from the repository's own release: GitHub is the authority on what was released;
//! - when the executable was placed by hand, not by `cargo install`, `cargo binstall` or a
//!   package manager, whose own bookkeeping a replaced file would contradict ([`InstallMethod`]).
//!
//! Downloading and replacing are behind the `self-update` feature (on by default), the
//! command line (`UpdateArgs`, `run`) behind `cli`; without `self-update` the crate only looks
//! releases up and words [`advice`].
//!
//! Restarting afterwards is the caller's: the CLI says so, and the GUI panel restarts the
//! app, its services or a bridge itself.

#![warn(missing_docs)]

mod install;
mod release;
#[cfg(feature = "self-update")]
mod replace;

#[cfg(feature = "cli")]
pub use install::UpdateArgs;
#[cfg(all(feature = "cli", feature = "self-update"))]
pub use install::run;
pub use install::{
    BinstallSource, InstallMethod, StoreKind, advice, advice_command, asset_name, cargo_home,
    install_method, platform,
};
#[cfg(feature = "self-update")]
pub use install::{download_asset, install};
pub use release::{Asset, Release, ReleaseSource, client, latest_release};
#[cfg(feature = "self-update")]
pub use replace::replace_file;

/// Errors from finding, fetching or installing a release.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Talking to GitHub failed.
    #[error("{0}")]
    Http(String),
    /// The repository has no release this source matches.
    #[error("{0}")]
    NoRelease(String),
    /// The release has no file for this platform.
    #[error("{0}")]
    NoAsset(String),
    /// The binary does not say where its releases are, or its own version is unusable.
    #[error("{0}")]
    NotConfigured(String),
    /// Reading the executable or writing its replacement failed.
    #[error(transparent)]
    Io(#[from] std::io::Error),
}

/// This crate's result.
pub type Result<T> = std::result::Result<T, Error>;