Struct PrereleaseVersion

Namespace: Ubiquity.NET.Versioning

Assembly: Ubiquity.NET.Versioning.dll

Pre-Release portion of a Constrained Semantic Version (CSemVer/CSemVer-CI)

public readonly record struct PrereleaseVersion : IEquatable<PrereleaseVersion>

Implements: IEquatable<PrereleaseVersion>

Inherited Members: ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Based on CSemVer v1.0.0-rc.1. This contains the PreRelease version details.

important

The default constructor for this value type is a valid pre-release alpha version. If an optional pre-release is intended then nullability should be used to indicate that and test for a null value.

Constructors

PrereleaseVersion(byte, byte, byte): Initializes a new instance of the PrereleaseVersion struct

PrereleaseVersion(string, byte, byte): Initializes a new instance of the PrereleaseVersion struct

Properties

Fix: Gets the Pre-Release fix [0-99]

Index: Gets the index value of this pre-release

Name: Gets the indexedName of this pre-release

Number: Gets the Pre-Release number [0-99]

Methods

FormatElements(bool): Gets this PrereleaseVersion as a sequence of strings

ToString(): Formats this instance as a string according to the rules of a Constrained Semantic Version

TryParseFrom(IReadOnlyList<string>): Tries to parse a PrereleaseVersion from a set of pre release parts from a version string