versionfmt

package

v2.1.0+incompatible Latest Latest Go to latest Published: Nov 5, 2019 License: Apache-2.0 Imports: 2 Imported by: 509

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/coreos/clair

Links

Open Source Insights

Documentation ¶

Overview ¶

Package versionfmt exposes functions to dynamically register formats used to parse Feature Versions.

Index ¶

Constants
Variables
func Compare(format, versionA, versionB string) (int, error)
func RegisterParser(name string, p Parser)
func Valid(format, version string) error
type Parser
- func GetParser(name string) (p Parser, exists bool)

Constants ¶

View Source

const (
	// MinVersion is a special package version which is always sorted first.
	MinVersion = "#MINV#"

	// MaxVersion is a special package version which is always sorted last.
	MaxVersion = "#MAXV#"
)

Variables ¶

View Source

var (
	// ErrUnknownVersionFormat is returned when a function does not have enough
	// context to determine the format of a version.
	ErrUnknownVersionFormat = errors.New("unknown version format")

	// ErrInvalidVersion is returned when a function needs to validate a version,
	// but should return an error in the case where the version is invalid.
	ErrInvalidVersion = errors.New("invalid version")
)

Functions ¶

func Compare ¶

func Compare(format, versionA, versionB string) (int, error)

Compare is a helper function that will compare two versions with a given format and return an error if there are any failures.

func RegisterParser ¶

func RegisterParser(name string, p Parser)

RegisterParser provides a way to dynamically register an implementation of a Parser.

If RegisterParser is called twice with the same name, the name is blank, or if the provided Parser is nil, this function panics.

func Valid ¶

func Valid(format, version string) error

Valid is a helper function that will return an error if the version fails to validate with a given format.

Types ¶

type Parser ¶

type Parser interface {
	// Valid attempts to parse a version string and returns its success.
	Valid(string) bool

	// Compare parses two different version strings.
	// Returns 0 when equal, -1 when a < b, 1 when b < a.
	Compare(a, b string) (int, error)
}

Parser represents any format that can compare two version strings.

func GetParser ¶

func GetParser(name string) (p Parser, exists bool)

GetParser returns the registered Parser with a provided name.

Source Files ¶

View all Source files

driver.go

Directories ¶

Path	Synopsis
dpkg Package dpkg implements a versionfmt.Parser for version numbers used in dpkg based software packages.	Package dpkg implements a versionfmt.Parser for version numbers used in dpkg based software packages.
rpm Package rpm implements a versionfmt.Parser for version numbers used in rpm based software packages.	Package rpm implements a versionfmt.Parser for version numbers used in rpm based software packages.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL