apiversion

README

apiversion

A Go library for parsing and comparing versions like v1alpha1 v1beta1, v1rc1 and v1 commonly found in Kubernetes.

Documentation

Index

• func Compare(x, y string) (int, error)
• func MustCompare(x, y string) int
• type InvalidVersion
  • func (e InvalidVersion) Error() string
• type Version
  • func NewVersion(s string) (*Version, error)
  • func (v Version) Compare(other Version) int

Functions

func Compare

func Compare(x, y string) (int, error)

Compare returns an integer comparing two version strings. The result will be 0 if x==y, -1 if x < y, and +1 if x > y. An error is returned, if version string can't be parsed.

func MustCompare

func MustCompare(x, y string) int

MustCompare returns an integer comparing two version strings. The result will be 0 if x==y, -1 if x < y, and +1 if x > y.

Types

type InvalidVersion

type InvalidVersion struct {
	// contains filtered or unexported fields
}

func (InvalidVersion) Error

func (e InvalidVersion) Error() string

type Version

type Version struct {
	X int
	Y string
	Z int
}

func NewVersion

func NewVersion(s string) (*Version, error)

func (Version) Compare

func (v Version) Compare(other Version) int

Compare returns an integer comparing two version strings. The result will be 0 if v==other, -1 if v < other, and +1 if v > other.