Struct UpdateConfigBuilder 

pub struct UpdateConfigBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> UpdateConfigBuilder<S>

pub fn build_async(self) -> AsyncUpdateChecker

where S: IsComplete,

Available on crate feature async only.

Build the configuration and return an AsyncUpdateChecker.

This is a convenience method that combines UpdateConfigBuilder::build with AsyncUpdateChecker::new.

nyquest_preset::register();
futures::executor::block_on(async {
    let checker = ib_update::github::UpdateConfig::builder()
        .owner("owner")
        .repo("repo")
        .current_version("1.0.0")
        .build_async();
    let info = checker.check().await?;
    println!("Latest: {}, update available: {}", info.latest().tag, info.has_update());
    Ok(())
})

impl<S: State> UpdateConfigBuilder<S>

pub fn build_blocking(self) -> UpdateChecker

where S: IsComplete,

Available on crate feature blocking only.

Build the configuration and return an UpdateChecker.

This is a convenience method that combines UpdateConfigBuilder::build with UpdateChecker::new.

nyquest_preset::register();
let checker = ib_update::github::UpdateConfig::builder()
    .owner("owner")
    .repo("repo")
    .current_version("1.0.0")
    .build_blocking();
let info = checker.check()?;
println!("Latest: {}, update available: {}", info.latest().tag, info.has_update());

impl<S: State> UpdateConfigBuilder<S>

pub fn build(self) -> UpdateConfig

where S: IsComplete,

Finish building and return the requested object

pub fn owner(self, value: impl Into<String>) -> UpdateConfigBuilder<SetOwner<S>>

where S::Owner: IsUnset,

Required.

GitHub repository owner (e.g. "rust-lang").

pub fn repo(self, value: impl Into<String>) -> UpdateConfigBuilder<SetRepo<S>>

where S::Repo: IsUnset,

Required.

GitHub repository name (e.g. "rust").

pub fn current_version( self, value: impl Into<String>, ) -> UpdateConfigBuilder<SetCurrentVersion<S>>

where S::CurrentVersion: IsUnset,

Optional (Some / Option setters). Current version to compare against.

pub fn maybe_current_version( self, value: Option<impl Into<String>>, ) -> UpdateConfigBuilder<SetCurrentVersion<S>>

where S::CurrentVersion: IsUnset,

Optional (Some / Option setters). Current version to compare against.

pub fn token(self, value: impl Into<String>) -> UpdateConfigBuilder<SetToken<S>>

where S::Token: IsUnset,

Optional (Some / Option setters). Optional personal access token for higher rate limits.

pub fn maybe_token( self, value: Option<impl Into<String>>, ) -> UpdateConfigBuilder<SetToken<S>>

where S::Token: IsUnset,

Optional (Some / Option setters). Optional personal access token for higher rate limits.

pub fn base_urls( self, value: Vec<String>, ) -> UpdateConfigBuilder<SetBaseUrls<S>>

where S::BaseUrls: IsUnset,

Optional (Some / Option setters). Default: vec!["https://api.github.com".into()].

Base URLs for the GitHub API. Defaults to https://api.github.com only.

pub fn maybe_base_urls( self, value: Option<Vec<String>>, ) -> UpdateConfigBuilder<SetBaseUrls<S>>

where S::BaseUrls: IsUnset,

Optional (Some / Option setters). Default: vec!["https://api.github.com".into()].

Base URLs for the GitHub API. Defaults to https://api.github.com only.

pub fn user_agent( self, value: impl Into<String>, ) -> UpdateConfigBuilder<SetUserAgent<S>>

where S::UserAgent: IsUnset,

Optional (Some / Option setters). Custom user-agent header value.

pub fn maybe_user_agent( self, value: Option<impl Into<String>>, ) -> UpdateConfigBuilder<SetUserAgent<S>>

where S::UserAgent: IsUnset,

Optional (Some / Option setters). Custom user-agent header value.

impl<S: State> UpdateConfigBuilder<S>

pub fn base_url(self, url: String) -> UpdateConfigBuilder<SetBaseUrls<S>>

where S::BaseUrls: IsUnset,

Available on crate features github-extra and multi-server only.

pub fn maybe_base_url( self, url: Option<String>, ) -> UpdateConfigBuilder<SetBaseUrls<S>>

where S::BaseUrls: IsUnset,

Available on crate features github-extra and multi-server only.