Struct GitVersion 

pub struct GitVersion {
    major: u64,
    minor: u64,
    patch: u64,
    commits_ahead: u64,
    hash: Option<String>,
    dirty: bool,
}

A parsed git describe version string.

Fields

major: u64

minor: u64

patch: u64

commits_ahead: u64

hash: Option<String>

dirty: bool

Implementations

impl GitVersion

pub fn parse(version: &str) -> Result<Self, VersionError>

Parses a version string in git describe format.

Supported formats:

• v0.9.46 - Tagged release
• v0.9.46-5-gabc123 - Development build with commits ahead
• v0.9.46-5-gabc123-dirty - Dirty working tree

Errors

Returns VersionError::InvalidFormat if the version string cannot be parsed.

Examples

use cadmus_core::version::GitVersion;

let v = GitVersion::parse("v0.9.46").unwrap();
assert_eq!(v.major(), 0);
assert_eq!(v.minor(), 9);
assert_eq!(v.patch(), 46);

pub fn major(&self) -> u64

Returns the major version number.

pub fn minor(&self) -> u64

Returns the minor version number.

pub fn patch(&self) -> u64

Returns the patch version number.

pub fn commits_ahead(&self) -> u64

Returns the number of commits ahead of the tag.

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

Returns the git hash if present.

pub fn is_dirty(&self) -> bool

Returns true if the working tree was dirty.

pub fn is_tagged_release(&self) -> bool

Returns true if this is a tagged release (no commits ahead).

pub fn compare( &self, other: &GitVersion, ) -> Result<VersionComparison, VersionError>

Compares this version with another.

If both versions contain different git hashes, this method will use the GitHub API to check ancestry relationships.

Examples

use cadmus_core::version::{GitVersion, VersionComparison};

// Local is newer than remote (higher semver)
let local: GitVersion = "v0.9.46".parse().unwrap();
let remote: GitVersion = "v0.9.45".parse().unwrap();
let result = local.compare(&remote).unwrap();
assert_eq!(result, VersionComparison::Newer);

// Local is older than remote (lower semver)
let local: GitVersion = "v0.9.44".parse().unwrap();
let remote: GitVersion = "v0.9.45".parse().unwrap();
let result = local.compare(&remote).unwrap();
assert_eq!(result, VersionComparison::Older);

// Local equals remote (same version)
let local: GitVersion = "v0.9.46".parse().unwrap();
let remote: GitVersion = "v0.9.46".parse().unwrap();
let result = local.compare(&remote).unwrap();
assert_eq!(result, VersionComparison::Equal);

Trait Implementations

impl Clone for GitVersion

fn clone(&self) -> GitVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitVersion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GitVersion

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GitVersion

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

Formats the value using the given formatter.

impl FromStr for GitVersion

type Err = VersionError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for GitVersion

fn eq(&self, other: &GitVersion) -> 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 Serialize for GitVersion

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GitVersion

impl StructuralPartialEq for GitVersion