Macro check_latest::versions

macro_rules! versions {
    () => { ... };
    (crate_name = $crate_name:expr, user_agent = $user_agent:expr $(,)?) => { ... };
    (user_agent = $user_agent:expr, crate_name = $crate_name:expr $(,)?) => { ... };
    (crate_name = $crate_name:expr $(,)?) => { ... };
    (user_agent = $user_agent:expr $(,)?) => { ... };
}

Deprecated since 0.4:

Please use Versions struct

Makes it easier to run get_versions.

versions!() will predict the crate_name and user_agent. crate_name will default to package name in your Cargo.toml file. user_agent will default to the name of your crate as defined in Cargo.toml followed by a / and the version of your package as defined in your Cargo.toml file (e.g. my-crate-name/1.0.0).

If you do not want these defaults to be used, you can set your own values. See the examples below.

Examples

Use Defaults

use check_latest::versions;
use semver::Version;

let current_version = Version::parse("1.0.0").unwrap();

if let Ok(versions) = versions!() {
    if versions.max_version > current_version {
        println!("Go get a new version!");
    }
}

Set Crate Name

use check_latest::versions;
use semver::Version;

let current_version = Version::parse("1.0.0").unwrap();

if let Ok(versions) = versions!(crate_name = "my-renamed-crate") {
    if versions.max_version > current_version {
        println!("Go get a new version!");
    }
}

Set User Agent

use check_latest::versions;
use semver::Version;

let current_version = Version::parse("1.0.0").unwrap();

if let Ok(versions) = versions!(user_agent = "my extra detailed user agent") {
    if versions.max_version > current_version {
        println!("Go get a new version!");
    }
}

Set Both

use check_latest::versions;
use semver::Version;

let current_version = Version::parse("1.0.0").unwrap();

let crate_name = "my-renamed-crate";
let user_agent = "my extra detailed user agent";

// This is reversible BTW
let versions = versions!(crate_name = crate_name, user_agent = user_agent);

if let Ok(versions) = versions {
    if versions.max_version > current_version {
        println!("Go get a new version!");
    }
}