Struct ReleaseList 

pub struct ReleaseList { /* private fields */ }

ReleaseList provides a builder api for querying a GitHub repo, returning a Vec of available Releases

Implementations

impl ReleaseList

pub fn configure() -> ReleaseListBuilder

Initialize a ReleaseListBuilder

Examples found in repository

examples/github.rs (line 14)

fn run() -> Result<(), Box<dyn ::std::error::Error>> {
    let mut rel_builder = self_update::backends::github::ReleaseList::configure();

    #[cfg(feature = "signatures")]
    rel_builder.repo_owner("Kijewski");
    #[cfg(not(feature = "signatures"))]
    rel_builder.repo_owner("jaemk");

    let releases = rel_builder.repo_name("self_update").build()?.fetch()?;
    println!("found releases:");
    println!("{:#?}\n", releases);

    let mut status_builder = self_update::backends::github::Update::configure();

    #[cfg(feature = "signatures")]
    status_builder
        .repo_owner("Kijewski")
        .verifying_keys([*include_bytes!("github-public.key")]);
    #[cfg(not(feature = "signatures"))]
    status_builder.repo_owner("jaemk");

    let status = status_builder
        .repo_name("self_update")
        .bin_name("github")
        .show_download_progress(true)
        //.target_version_tag("v9.9.10")
        //.show_output(false)
        //.no_confirm(true)
        //
        // For private repos, you will need to provide a GitHub auth token
        // **Make sure not to bake the token into your app**; it is recommended
        // you obtain it via another mechanism, such as environment variables
        // or prompting the user for input
        //.auth_token(env!("DOWNLOAD_AUTH_TOKEN"))
        .current_version(cargo_crate_version!())
        .build()?
        .update()?;
    println!("Update status: `{}`!", status.version());
    Ok(())
}

pub fn fetch(self) -> Result<Vec<Release>>

Retrieve a list of Releases. If specified, filter for those containing a specified target

Examples found in repository

examples/github.rs (line 21)

fn run() -> Result<(), Box<dyn ::std::error::Error>> {
    let mut rel_builder = self_update::backends::github::ReleaseList::configure();

    #[cfg(feature = "signatures")]
    rel_builder.repo_owner("Kijewski");
    #[cfg(not(feature = "signatures"))]
    rel_builder.repo_owner("jaemk");

    let releases = rel_builder.repo_name("self_update").build()?.fetch()?;
    println!("found releases:");
    println!("{:#?}\n", releases);

    let mut status_builder = self_update::backends::github::Update::configure();

    #[cfg(feature = "signatures")]
    status_builder
        .repo_owner("Kijewski")
        .verifying_keys([*include_bytes!("github-public.key")]);
    #[cfg(not(feature = "signatures"))]
    status_builder.repo_owner("jaemk");

    let status = status_builder
        .repo_name("self_update")
        .bin_name("github")
        .show_download_progress(true)
        //.target_version_tag("v9.9.10")
        //.show_output(false)
        //.no_confirm(true)
        //
        // For private repos, you will need to provide a GitHub auth token
        // **Make sure not to bake the token into your app**; it is recommended
        // you obtain it via another mechanism, such as environment variables
        // or prompting the user for input
        //.auth_token(env!("DOWNLOAD_AUTH_TOKEN"))
        .current_version(cargo_crate_version!())
        .build()?
        .update()?;
    println!("Update status: `{}`!", status.version());
    Ok(())
}

Trait Implementations

impl Clone for ReleaseList

fn clone(&self) -> ReleaseList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReleaseList

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

Formats the value using the given formatter.