Struct version_compare::Manifest

#[non_exhaustive]
pub struct Manifest {
    pub max_depth: Option<usize>,
    pub ignore_text: bool,
    pub gnu_ordering: bool,
}

Version manifest (configuration).

A manifest (configuration) that is used respectively when parsing and comparing version strings.

Examples

use version_compare::{Manifest, Version};

// Create manifest with max depth of 2
let mut manifest = Manifest::default();
manifest.max_depth = Some(2);

// Version strings equal with manifest because we compare up-to 2 parts deep
let a = Version::from_manifest("1.0.1", &manifest).unwrap();
let b = Version::from_manifest("1.0.2", &manifest).unwrap();
assert!(a == b);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_depth: Option<usize>

The maximum depth of a version number.

This specifies the maximum number of parts. There is no limit if None is set.

ignore_text: bool

Whether to ignore text parts in version strings.

gnu_ordering: bool

Use GNU sort based ordering.

Enabling this modifies the ordering of numbers with a leading zero to mimick GNUs sort.

Issue: https://github.com/timvisee/version-compare/issues/27

Implementations

impl Manifest

Version manifest implementation.

pub fn has_max_depth(&self) -> bool

Check whether there’s a maximum configured depth.

Examples

use version_compare::Manifest;

let mut manifest = Manifest::default();

assert!(!manifest.has_max_depth());

manifest.max_depth = Some(3);
assert!(manifest.has_max_depth());

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl Default for Manifest

fn default() -> Manifest

Returns the “default value” for a type.

impl PartialEq for Manifest

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

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

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

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

impl Copy for Manifest

impl Eq for Manifest

impl StructuralPartialEq for Manifest