[](https://travis-ci.org/timvisee/version-compare)
[](https://crates.io/crates/version-compare)
[](https://crates.io/crates/version-compare)
[](https://coveralls.io/github/timvisee/version-compare?branch=master)
[](https://libraries.io/github/timvisee/version-compare)
[](https://crates.io/crates/version-compare)
# Rust library: version-compare
> A Rust library to easily compare version numbers, and test them against various comparison operators.
[Documentation](https://docs.rs/version-compare)
Comparing version numbers is hard. Especially when version numbers get really complex,
or when their formatting differs.
This library helps you to easily compare any kind of version number with a single code-statement.
Two version numbers can be compared to each other, to get a relevant comparison operator (`<`, `==`, `>`),
or version numbers can be tested against any given comparison operator.
Along with version comparison, the library also features other useful tools.
For example: version numbers can be parsed to inspect a version number by it's bare numeric or text based parts.
Inspired by PHPs [version_compare()](http://php.net/manual/en/function.version-compare.php).
Note: This library is still a work in progress.
See the list below for a list of currently available and future features.
## Features
* Compare two version numbers, get: `<`, `==` or `>`.
* Compare two version numbers against any comparison operator.
* Parse complex version numbers.
* Static, single-statement methods available.
The following features will be added in a later version:
* Support for text parts in version strings.
* Version manifest, to specify detailed version number constraints.
* Batch comparisons.
## Example
This library is very easy to use. Here's a basic usage example:
Cargo.toml:
```toml
[dependencies]
version-compare = "0.0.5"
```
[main.rs:](examples/example.rs)
```rust
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, false);
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!()
}
}
```
Check out the [examples](examples) directory for more complete examples.
## Builds
This library is automatically build and tested for each commit using CI services.
|Travis CI|master|[](https://travis-ci.org/timvisee/version-compare)|[View Status](https://travis-ci.org/timvisee/version-compare)|
|Travis CI|last commit|[](https://travis-ci.org/timvisee/version-compare)|[View Status](https://travis-ci.org/timvisee/version-compare)|
## License
This project is released under the GNU GPL-3.0 license. Check out the [LICENSE](LICENSE) file for more information.