Advanced version string comparison library.
Need to compare software, package or whatever versions? Comparing
1.0 and 1.1 could be easy, but are you ready for more
complex cases like 1.2-x.3~alpha4? libversion is, which
is proven by using the library in Repology
project which relies on comparing software version strings, even
if they are written in different formats.
A short list of version features libversion handles for you:
- Simple versions, obviously:
0.9 < 1.0 < 1.1 - Omitting insignificant components:
1.0 == 1.0.0 - Leading zeroes:
1.001 == 1.1 - Unusual separators:
1_2~3 == 1.2.3 - Letter suffixes:
1.2 < 1.2a < 1.2b < 1.3 - Alphanumeric prerelease components:
1.0alpha1 == 1.0.alpha1 == 1.0a1 == 1.0.a11.0alpha1 < 1.0alpha2 < 1.0beta1 < 1.0rc1 < 1.0
- Awareness of prerelease keywords: while
1.0 < 1.0a-1(a treated as version addendum), but1.0alpha-1 < 1.0(alpha is treated as prerelease marker) - Awareness of patch, post and pl keywords: while
1.0alpha1 < 1.0(alpha is pre-release),1.0 < 1.0patch1 < 1.1(patch is post-release) - Customizable handling of p keyword (it may mean either patch or pre, and since libversion cannot guess, this is controlled with an external flag)
Version comparison has O(N) complexity, implements a total order,
is case insensitive, does not allocate, does not fail. Versions strings
are treated as ASCII, Unicode characters will be treated as separators.
The library provides both C-ish API resembling one of C libversion
use libversion::{VersionFlags, version_compare2, version_compare4};
use std::cmp::Ordering;
// Version comparison
assert_eq!(version_compare2("0.99", "1.01"), Ordering::Less);
assert_eq!(version_compare2("1.1", "1.01.0"), Ordering::Equal);
assert_eq!(version_compare2("1.0alpha1", "1.0.beta.1"), Ordering::Less);
assert_eq!(version_compare2("1.0.beta.2", "1.0.rc1"), Ordering::Less);
assert_eq!(version_compare2("1.0", "1.0-rc1"), Ordering::Greater);
// Ordering
let mut versions = vec!["1.0rc1", "1.0beta1", "1.0", "1.0alpha1", "0.99"];
versions.sort_by(|a, b| version_compare2(a, b));
assert_eq!(versions, vec!["0.99", "1.0alpha1", "1.0beta1", "1.0rc1", "1.0"]);
// With flags to tune behavior, e.g. how to resolve ambiguous cases
assert_eq!(version_compare4("1.0p1", "1.0pre1", VersionFlags::empty(), VersionFlags::empty()), Ordering::Equal);
assert_eq!(version_compare4("1.0p1", "1.0patch1", VersionFlags::empty(), VersionFlags::empty()), Ordering::Less);
assert_eq!(version_compare4("1.0p1", "1.0pre1", VersionFlags::P_IS_PATCH, VersionFlags::empty()), Ordering::Greater);
assert_eq!(version_compare4("1.0p1", "1.0patch1", VersionFlags::P_IS_PATCH, VersionFlags::empty()), Ordering::Equal);and a Rust type storing version string along with flags, providing
convenient Eq and Ord implementations.
use libversion::{VersionFlags, Version};
// Use with either owning or borrowed strings
assert!(Version::new("1.0") == Version::new("1.0".to_string()));
// Compare and order
assert!(Version::new("0.99") < Version::new("1.01"));
assert!(Version::new("1.1") == Version::new("1.01.0"));
let mut versions = vec!["1.0rc1", "1.0beta1", "1.0", "1.0alpha1", "0.99"];
versions.sort_by_key(|v| Version::new(*v));
assert_eq!(versions, vec!["0.99", "1.0alpha1", "1.0beta1", "1.0rc1", "1.0"]);
// With flags
assert!(Version::with_flags("1.0p1", VersionFlags::P_IS_PATCH) == Version::new("1.0patch1"));This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust.
libversion supports current stable Rust version and 2 most recent minor releases before it.
Increasing MSRV is not considered a semver breaking change as long as it follows this policy.
The current MSRV is 1.88.
See https://docs.rs/libversion/latest/libversion/ for complete documentation.
- Go: golibversion by @saenai255
- Perl: Version::libversion::XS by @giterlizzi
- Python: py-libversion by @AMDmi3
- Raku: Version::Repology by @lizmat (a pure Raku implementation)
- Ruby: ruby-libversion by @Zopolis4
- C: libversion by @AMDmi3 (original C implementation)
- MIT OR Apache-2.0