Struct debian_packaging::package_version::PackageVersion

pub struct PackageVersion { /* private fields */ }

A Debian package version.

Debian package versions consist of multiple sub-components and have rules about sorting. The semantics are defined at https://www.debian.org/doc/debian-policy/ch-controlfields.html#version. This type attempts to implement all the details.

The concise version is the format is [epoch:]upstream_version[-debian_revision] and each component has rules about what characters are allowed. Our Self::parse() should be compliant with the specification and reject invalid version strings and parse components to the appropriate field.

This type implements a custom ordering function that implements the complex rules around Debian package version ordering.

use debian_packaging::package_version::PackageVersion;

let v = PackageVersion::parse("1:4.7.0+dfsg1-2").unwrap();
assert_eq!(v.epoch(), Some(1));
assert_eq!(v.upstream_version(), "4.7.0+dfsg1");
assert_eq!(v.debian_revision(), Some("2"));
assert_eq!(format!("{}", v), "1:4.7.0+dfsg1-2");

assert!(v < PackageVersion::parse("1:4.7.0+dfsg1-3").unwrap());

Implementations

impl PackageVersion

pub fn parse(s: &str) -> Result<Self>

Construct an instance by parsing a version string.

pub fn epoch(&self) -> Option<u32>

The epoch component of the version string.

Only Some if present or defined explicitly.

pub fn epoch_assumed(&self) -> u32

Assumed value of epoch component.

If the component isn’t explicitly defined, a default of 0 will be assumed.

pub fn upstream_version(&self) -> &str

upstream component of the version string.

This is the main part of the version number.

It is typically the original version of the software from which this package came. Although it may be massaged to be compatible with packaging requirements.

pub fn debian_revision(&self) -> Option<&str>

debian_revision component of the version string.

The part of the version string that specifies the version of the Debian package based on the upstream version.

Trait Implementations

impl Clone for PackageVersion

fn clone(&self) -> PackageVersion

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PackageVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for PackageVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for PackageVersion

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PackageVersion> for PackageVersion

fn eq(&self, other: &PackageVersion) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PackageVersion) -> bool

This method tests for !=.

impl PartialOrd<PackageVersion> for PackageVersion

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PackageVersion

impl StructuralEq for PackageVersion

impl StructuralPartialEq for PackageVersion