Struct nextsv_lib::VersionTag

pub struct VersionTag { /* private fields */ }

Describes a tag

Implementations

impl VersionTag

pub fn name(&self) -> Semantic

The name field

pub fn id(&self) -> Oid

The id field

pub fn feat_commits(&self) -> u32

The count of feature commits in the conventional commits field If the conventional commits field has not been set returns 0

pub fn fix_commits(&self) -> u32

The count of fix commits in the conventional commits field If the conventional commits field has not been set returns 0

pub fn docs_commits(&self) -> u32

The count of docs commits in the conventional commits field If the conventional commits field has not been set returns 0

pub fn chore_commits(&self) -> u32

The count of chore commits in the conventional commits field If the conventional commits field has not been set returns 0

pub fn refactor_commits(&self) -> u32

The count of refactor commits in the conventional commits field If the conventional commits field has not been set returns 0

pub fn breaking(&self) -> bool

The breaking flag in the conventional commits field If the conventional commits field has not been set returns false

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

The latest semantic version tag (vx.y.z)

pub fn force_major(&mut self) -> Self

Construct conventional commits that forces Major update

pub fn force_minor(&mut self) -> Self

Construct conventional commits that forces Minor update

pub fn force_patch(&mut self) -> Self

Construct conventional commits that forces Patch update

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

Promote the first production version (1.0.0)

pub fn commits(self) -> Result<Self, Error>

The number of conventional commits created since the tag was created

pub fn next_version(&mut self) -> Semantic

pub fn next_level(&mut self) -> Result<Level, Error>

pub fn bump_level(&self) -> Option<Level>

Trait Implementations

impl Clone for VersionTag

fn clone(&self) -> VersionTag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VersionTag

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

Formats the value using the given formatter.

impl Ord for VersionTag

fn cmp(&self, other: &VersionTag) -> 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<VersionTag> for VersionTag

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

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

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

This method tests for !=.

impl PartialOrd<VersionTag> for VersionTag

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

impl StructuralEq for VersionTag

impl StructuralPartialEq for VersionTag