Struct MinimalVersion

pub struct MinimalVersion {
    pub pkgver: PackageVersion,
    pub epoch: Option<Epoch>,
}

A package version without a PackageRelease.

Tracks an optional Epoch and a PackageVersion, but no PackageRelease. This reflects the minimal and minimal with epoch forms of alpm-package-version.

Notes

• If PackageRelease should be optional for your use-case, use Version instead.
• If PackageRelease should be mandatory for your use-case, use FullVersion instead.

Examples

use std::str::FromStr;

use alpm_types::MinimalVersion;

// A minimal version.
let version = MinimalVersion::from_str("1.0.0")?;

// A minimal version with epoch.
let version = MinimalVersion::from_str("1:1.0.0")?;

Fields

pkgver: PackageVersion

The version of the package

epoch: Option<Epoch>

The epoch of the package

Implementations

impl MinimalVersion

pub fn new(pkgver: PackageVersion, epoch: Option<Epoch>) -> Self

Creates a new MinimalVersion.

Examples

use alpm_types::{Epoch, MinimalVersion, PackageVersion};

// A minimal version.
let version = MinimalVersion::new(PackageVersion::new("1.0.0".to_string())?, None);

// A minimal version with epoch.
let version = MinimalVersion::new(
    PackageVersion::new("1.0.0".to_string())?,
    Some(Epoch::new(1.try_into()?)),
);

pub fn vercmp(&self, other: &MinimalVersion) -> i8

Compares self to another MinimalVersion and returns a number.

• 1 if self is newer than other
• 0 if self and other are equal
• -1 if self is older than other

This output behavior is based on the behavior of the vercmp tool.

Delegates to MinimalVersion::cmp for comparison. The rules and algorithms used for comparison are explained in more detail in alpm-package-version and alpm-pkgver.

Examples

use std::str::FromStr;

use alpm_types::MinimalVersion;

assert_eq!(
    MinimalVersion::from_str("1.0.0")?.vercmp(&MinimalVersion::from_str("0.1.0")?),
    1
);
assert_eq!(
    MinimalVersion::from_str("1.0.0")?.vercmp(&MinimalVersion::from_str("1.0.0")?),
    0
);
assert_eq!(
    MinimalVersion::from_str("0.1.0")?.vercmp(&MinimalVersion::from_str("1.0.0")?),
    -1
);

pub fn parser(input: &mut &str) -> ModalResult<Self>

Recognizes a MinimalVersion in a string slice.

Consumes all of its input.

Errors

Returns an error if input is not a valid alpm-package-version (full or full with epoch).

Trait Implementations

impl Clone for MinimalVersion

fn clone(&self) -> MinimalVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MinimalVersion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MinimalVersion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MinimalVersion

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

Formats the value using the given formatter.

impl From<&MinimalVersion> for Version

fn from(value: &MinimalVersion) -> Self

Creates a Version from a MinimalVersion reference.

impl From<MinimalVersion> for Version

fn from(value: MinimalVersion) -> Self

Creates a Version from a MinimalVersion.

impl FromStr for MinimalVersion

fn from_str(s: &str) -> Result<Self, Self::Err>

Creates a new MinimalVersion from a string slice.

Delegates to MinimalVersion::parser.

Errors

Returns an error if Version::parser fails.

type Err = Error

The associated error which can be returned from parsing.

impl Ord for MinimalVersion

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

Compares self to another MinimalVersion.

The comparison rules and algorithms are explained in more detail in alpm-package-version and alpm-pkgver.

Examples

use std::{cmp::Ordering, str::FromStr};

use alpm_types::MinimalVersion;

// Examples for "minimal"
let version_a = MinimalVersion::from_str("0.1.0")?;
let version_b = MinimalVersion::from_str("1.0.0")?;
assert_eq!(version_a.cmp(&version_b), Ordering::Less);
assert_eq!(version_b.cmp(&version_a), Ordering::Greater);

let version_a = MinimalVersion::from_str("1.0.0")?;
let version_b = MinimalVersion::from_str("1.0.0")?;
assert_eq!(version_a.cmp(&version_b), Ordering::Equal);

// Examples for "minimal with epoch"
let version_a = MinimalVersion::from_str("1:1.0.0")?;
let version_b = MinimalVersion::from_str("1.0.0")?;
assert_eq!(version_a.cmp(&version_b), Ordering::Greater);
assert_eq!(version_b.cmp(&version_a), Ordering::Less);

let version_a = MinimalVersion::from_str("1:1.0.0")?;
let version_b = MinimalVersion::from_str("1:1.0.0")?;
assert_eq!(version_a.cmp(&version_b), Ordering::Equal);

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MinimalVersion

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MinimalVersion

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for MinimalVersion

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Version> for MinimalVersion

fn try_from(value: &Version) -> Result<Self, Self::Error>

Creates a MinimalVersion from a Version reference.

Errors

Returns an error if value.pkgrel is None.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Version> for MinimalVersion

fn try_from(value: Version) -> Result<Self, Self::Error>

Creates a MinimalVersion from a Version.

Errors

Returns an error if value.pkgrel is None.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for MinimalVersion

impl StructuralPartialEq for MinimalVersion