semver

Documentation

Index

• type SemVersion
  • func NewSemVersion(version string) (*SemVersion, error)
  • func (v *SemVersion) CompareTo(from *SemVersion) int
  • func (v *SemVersion) CompareToPrereleaseInts(from *SemVersion) (int, error)
  • func (v *SemVersion) IsEqualTo(from *SemVersion) bool
  • func (v *SemVersion) IsEqualToOrPatchVersionOf(from *SemVersion) bool
  • func (v *SemVersion) IsGreaterThanOrEqualTo(from *SemVersion) bool
  • func (v *SemVersion) IsGreatherThan(from *SemVersion) bool
  • func (v *SemVersion) IsLessThan(from *SemVersion) bool
  • func (v *SemVersion) ToString() string
  • func (v *SemVersion) ToStringWithoutBuildAndPrerelease() string

Types

type SemVersion

type SemVersion struct {
	Major      int64
	Minor      int64
	Patch      int64
	Prerelease string
	Build      string
}

SemVersion Implements a basic notion a semantic version (see https://semver.org/, test page: https://regex101.com/r/vkijKf/1/)

func NewSemVersion

func NewSemVersion(version string) (*SemVersion, error)

NewSemVersion Create an instance of a SemVersion

func (*SemVersion) CompareTo

func (v *SemVersion) CompareTo(from *SemVersion) int

CompareTo Compares the current version to another version - if from > this, -1 is returned - if from < this, 1 is returned - if they are equal, 0 is returned

func (*SemVersion) CompareToPrereleaseInts

func (v *SemVersion) CompareToPrereleaseInts(from *SemVersion) (int, error)

CompareToPrereleaseInts Compares the current version to another version treating the Prerelease field as an int - if from > this, -1 is returned - if from < this, 1 is returned - if they are equal, 0 is returned - if the prerelease field can not be converted to an int, it will return an error

func (*SemVersion) IsEqualTo

func (v *SemVersion) IsEqualTo(from *SemVersion) bool

IsEqualTo Returns true if to == from

func (*SemVersion) IsEqualToOrPatchVersionOf

func (v *SemVersion) IsEqualToOrPatchVersionOf(from *SemVersion) bool

IsEqualOrPatchVersionOf Returns true if to == from or to is a patch version of from

func (*SemVersion) IsGreaterThanOrEqualTo

func (v *SemVersion) IsGreaterThanOrEqualTo(from *SemVersion) bool

IsGreaterThanOrEqualTo Returns true if to >= from

func (*SemVersion) IsGreatherThan

func (v *SemVersion) IsGreatherThan(from *SemVersion) bool

IsGreatherThan Returns true if to > from

func (*SemVersion) IsLessThan

func (v *SemVersion) IsLessThan(from *SemVersion) bool

IsLessThan Returns true if to < from

func (*SemVersion) ToString

func (v *SemVersion) ToString() string

ToString Convert to a valid semver string representation

func (*SemVersion) ToStringWithoutBuildAndPrerelease

func (v *SemVersion) ToStringWithoutBuildAndPrerelease() string

ToStringWithoutBuildAndPrerelease Convert to a valid semver string representation without the build and pre-release fields