README
¶
LaunchDarkly Semantic Version Package
Overview
This Go package implements parsing and comparison of semantic version (semver) strings, as defined by the Semantic Versioning 2.0.0 specification.
Several semver implementations exist for Go. This implementation was designed for high performance in applications where semver operations may be done frequently, such as in the LaunchDarkly Go SDK. To that end, it does not use regular expressions and it never allocates data on the heap.
It does not include any additional functionality beyond what is defined in the Semantic Versioning 2.0.0 specification, such as comparison against range/wildcard expressions like ">=1.0.0" or "2.5.x".
This package has no external dependencies other than the regular Go runtime.
Supported Go versions
This version of the project has been tested with Go 1.14 and above.
Contributing
We encourage pull requests and other contributions from the community. Check out our contributing guidelines for instructions on how to contribute to this project.
Documentation
¶
Index ¶
- Constants
- type ParseMode
- type ValuesGenerator
- func (g *ValuesGenerator) AddValue(min, max int) *ValuesGenerator
- func (g ValuesGenerator) MakeAllPermutations() [][]int
- func (g ValuesGenerator) TestAll(t *testing.T, action func(*testing.T, []int))
- func (g ValuesGenerator) TestAll1(t *testing.T, action func(*testing.T, int))
- func (g ValuesGenerator) TestAll2(t *testing.T, action func(*testing.T, int, int))
- func (g ValuesGenerator) TestAll3(t *testing.T, action func(*testing.T, int, int, int))
- func (g ValuesGenerator) TestAll4(t *testing.T, action func(*testing.T, int, int, int, int))
- type Version
Constants ¶
const ( // ParseModeStrict is the default parsing mode, requiring a strictly correct version string with // all three required numeric components. ParseModeStrict = iota // ParseModeAllowMissingMinorAndPatch is a parsing mode in which the version string may omit the patch // version component ("2.1"), or both the minor and patch version components ("2"), in which case // they are assumed to be zero. ParseModeAllowMissingMinorAndPatch = iota )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ValuesGenerator ¶ added in v1.0.2
type ValuesGenerator struct {
// contains filtered or unexported fields
}
func NewValuesGenerator ¶ added in v1.0.2
func NewValuesGenerator() *ValuesGenerator
func (*ValuesGenerator) AddValue ¶ added in v1.0.2
func (g *ValuesGenerator) AddValue(min, max int) *ValuesGenerator
func (ValuesGenerator) MakeAllPermutations ¶ added in v1.0.2
func (g ValuesGenerator) MakeAllPermutations() [][]int
type Version ¶
type Version struct {
// contains filtered or unexported fields
}
Version is a semantic version as defined by the Semantic Versions 2.0.0 standard (http://semver.org).
This type provides only parsing and simple precedence comparison, since those are the only features required by the LaunchDarkly Go SDK.
func Parse ¶
Parse attempts to parse a string into a Version. It only accepts strings that strictly match the specification, so extensions like a "v" prefix are not allowed.
If parsing fails, it returns a non-nil error as the second return value, and Version{} as the first.
func ParseAs ¶
ParseAs attempts to parse a string into a Version, using the specified ParseMode.
If parsing fails, it returns a non-nil error as the second return value, and Version{} as the first.
func (Version) ComparePrecedence ¶
ComparePrecedence compares this Version to another Version according to the canonical precedence rules. It returns -1 if v has lower precedence than other, 1 if v has higher precedence, or 0 if the same.
func (Version) GetPrerelease ¶
GetPrerelease returns the prerelease version component, or "" if there is none.
Source Files