Skip to main content

SemanticVersion

Struct SemanticVersion 

Source
pub struct SemanticVersion {
    pub version: Version,
    pub prerelease: String,
    pub build_metadata: String,
}
Expand description

Describes a numeric version with optional prerelease and build metadata.

Unlike crates that accept only SemVer 2, this type intentionally supports the two- to four-part version grammar used by Nerdbank.GitVersioning, along with the {height} macro in prerelease and build metadata identifiers.

Fields§

§version: Version

The numeric portion of the version.

§prerelease: String

The prerelease portion, including its leading hyphen, or an empty string.

§build_metadata: String

The build metadata, including its leading plus, or an empty string.

Implementations§

Source§

impl SemanticVersion

Source

pub fn new( version: Version, prerelease: impl Into<String>, build_metadata: impl Into<String>, ) -> Result<Self>

Initializes a semantic version, validating the prerelease and build metadata strings.

Source

pub fn try_parse(value: &str) -> Option<Self>

Parses a semantic version, returning None when the input is invalid.

Source

pub fn version_height_position(&self) -> Option<VersionPosition>

Gets the position where version height should appear.

Source

pub fn git_commit_id_position(&self) -> Option<VersionPosition>

Gets the position where the first 16 bits of a Git commit ID should appear, if any.

Source

pub fn read_version_position(&self, position: VersionPosition) -> Result<i64>

Reads one of the four numeric version positions, using -1 for an unspecified build or revision.

Source

pub fn will_version_change_reset_version_height( first: &Self, second: &Self, version_height_position: VersionPosition, ) -> Result<bool>

Tests whether changing between two semantic versions resets version height at the specified position.

Source

pub fn is_matching_version(&self, version: &Version) -> bool

Checks whether a numeric version may have been produced by this semantic version specification.

Source

pub fn contains(&self, version: &Version) -> bool

Checks whether a numeric version belongs to the set represented by this semantic version specification.

Source

pub fn increment(&self, increment: ReleaseVersionIncrement) -> Result<Self>

Gets a new semantic version with the specified numeric component incremented.

Incrementing build is invalid when the build component is unspecified. Components after the incremented component are reset to zero while the original component count, prerelease, and build metadata are preserved.

Source

pub fn set_first_prerelease_tag(&self, new_first_tag: &str) -> Result<Self>

Sets the first prerelease identifier. The leading hyphen may be specified or omitted. An empty value removes the first identifier.

Source

pub fn without_prerelease_tags(&self) -> Self

Returns a copy without any prerelease identifiers.

Source

pub fn make_prerelease_semver1_compliant( prerelease: &str, padding_size: usize, ) -> String

Converts a SemVer 2 prerelease such as -beta.5 to a SemVer 1 compatible value such as -beta-0005.

Numeric identifiers are left-padded to at least padding_size digits, and dots are replaced by hyphens.

Trait Implementations§

Source§

impl Clone for SemanticVersion

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SemanticVersion

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SemanticVersion

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SemanticVersion

Source§

impl FromStr for SemanticVersion

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(value: &str) -> Result<Self>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for SemanticVersion

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SemanticVersion

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SemanticVersion

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.