Struct nextsv_lib::Semantic

pub struct Semantic { /* private fields */ }

The Semantic data structure represents a semantic version number.

TODO: Implement support for pre-release and build

Implementations

impl Semantic

pub fn parse(tag: &str, version_prefix: &str) -> Result<Self, Error>

Parse a tag and return a struct String format expect: <version_prefix>x.y.z

Fields

tag - the tag proposed as a semantic version tag version_prefix - any string before the semantic version number

Example

Parse a tag into a semantic version number where “v” is used to identify tags representing semantic version numbers.

use nextsv_lib::Semantic;

let tag = "v0.2.3";
let semantic_version = Semantic::parse(tag, "v")?;

assert_eq!(0, semantic_version.major());
assert_eq!(2, semantic_version.minor());
assert_eq!(3, semantic_version.patch());

to identify tags with semantic version numbers the tag name can be parsed

pub fn breaking_increment(&mut self) -> &mut Self

Increment the version based on a breaking change When the major number is 0 increment the minor number else increment the major number

pub fn increment_patch(&mut self) -> &mut Self

Increment the patch component of the version number by 1

pub fn increment_minor(&mut self) -> &mut Self

Increment the minor component of the version number by 1

pub fn increment_major(&mut self) -> &mut Self

Increment the major component of the version number by 1

pub fn first_production(&mut self) -> Result<&mut Self, Error>

Set the first production release version

pub fn major(&self) -> usize

pub fn minor(&self) -> usize

pub fn patch(&self) -> usize

Trait Implementations

impl Clone for Semantic

fn clone(&self) -> Semantic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Semantic

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

Formats the value using the given formatter.

impl Default for Semantic

fn default() -> Semantic

Returns the “default value” for a type.

impl Display for Semantic

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

Formats the value using the given formatter.

impl Ord for Semantic

fn cmp(&self, other: &Semantic) -> 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 where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Semantic> for Semantic

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

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

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

This method tests for !=.

impl PartialOrd<Semantic> for Semantic

fn partial_cmp(&self, other: &Semantic) -> 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 Semantic

impl StructuralEq for Semantic

impl StructuralPartialEq for Semantic