[][src]Function check_latest::async::get_newest_version

pub async fn get_newest_version<'_, '_, '_>(
    crate_name: &'_ str,
    current_crate_version: &'_ str,
    user_agent: &'_ str
) -> Result<Option<Version>>
Deprecated since 0.4:

Please use Versions struct

NOTE You probably want to use newest_version_async!

Compares the current crate version to the newest version available on Crates.io.

Please note that the newest version is not always the maximum version. A patch may have been released for an old major version that is still being maintained, for example.

Returns

  • Ok(Some(version)) if the current version < newest version
  • `Ok(None) if current version >= newest version
  • Err(_) if there was a failure to get and compare the versions

Example

use check_latest::r#async::get_newest_version;

let name = "my-awesome-crate-bin";
let version = "1.0.0";
let user_agent = format!("{}/{}", name, version);

if let Ok(Some(version)) = get_newest_version(name, version, &user_agent).await {
    println!("Go get version {}!", version);
}