apiversion

Documentation

Overview

Copyright 2021 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func IsValidVersion(name string) bool
• type Comparison
• type Version
  • func NewVersion(name string) (version Version, err error)
  • func NewVersionOrPanic(name string) Version
  • func (v Version) Compare(other Version) Comparison
  • func (v Version) String() string

Functions

func IsValidVersion

func IsValidVersion(name string) bool

IsValidVersion returns true iff the input is a valid version name.

Types

type Comparison

type Comparison int

const (
	Lesser  Comparison = -1
	Equal   Comparison = 0
	Greater Comparison = 1
)

type Version

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

func NewVersion

func NewVersion(name string) (version Version, err error)

NewVersion builds a Version from a version string, eg "v1alpha2"

func NewVersionOrPanic

func NewVersionOrPanic(name string) Version

NewVersionOrPanic is the same as NewVersion, but panics if passed an invalid version name.

func (Version) Compare

func (v Version) Compare(other Version) Comparison

Compare return Lesser if v < other (ie other is more recent), Equal if v == other, and Greater if v > other (ie v is more recent)

func (Version) String

func (v Version) String() string