version-compare 0.0.13

A Rust library to easily compare version numbers, and test them against various comparison operators.
Documentation
//! Usage examples of the version-compare library.
//!
//! This file shows various ways this library supports for comparing version numbers,
//! and it shows various ways of implementing it in code logic such as with a `match` statement.
//!
//! The `assert_eq!(...)` macros are used to assert the returned value by a given statement.
//!
//! You can run this example file by using the command `cargo run --example example`.

extern crate version_compare;

use version_compare::{CompOp, Version, VersionCompare};

fn main() {
    // Define some version numbers
    let a = "1.2";
    let b = "1.5.1";

    // The following comparison operators are used:
    // - CompOp::Eq -> Equal
    // - CompOp::Ne -> Not equal
    // - CompOp::Lt -> Less than
    // - CompOp::Le -> Less than or equal
    // - CompOp::Ge -> Greater than or equal
    // - CompOp::Gt -> Greater than

    // Easily compare version strings
    assert_eq!(VersionCompare::compare(&a, &b).unwrap(), CompOp::Lt);
    assert_eq!(
        VersionCompare::compare_to(&a, &b, &CompOp::Le).unwrap(),
        true
    );
    assert_eq!(
        VersionCompare::compare_to(&a, &b, &CompOp::Gt).unwrap(),
        false
    );

    // Version string parsing
    let a_ver = Version::from(a).unwrap();
    let b_ver = Version::from(b).unwrap();

    // Directly compare parsed versions
    assert_eq!(a_ver < b_ver, true);
    assert_eq!(a_ver <= b_ver, true);
    assert_eq!(a_ver > b_ver, false);
    assert_eq!(a_ver != b_ver, true);
    assert_eq!(a_ver.compare(&b_ver), CompOp::Lt);
    assert_eq!(b_ver.compare(&a_ver), CompOp::Gt);
    assert_eq!(a_ver.compare_to(&b_ver, &CompOp::Lt), true);

    // Match
    match a_ver.compare(&b_ver) {
        CompOp::Lt => println!("Version a is less than b"),
        CompOp::Eq => println!("Version a is equal to b"),
        CompOp::Gt => println!("Version a is greater than b"),
        _ => unreachable!(),
    }
}