compare

Documentation

Overview

Copyright 2022 The Tekton 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

• Variables
• func EquateEmptyResourceList() cmp.Option
• func IsEmpty(x corev1.ResourceList) bool
• func IsZero(q resource.Quantity) bool
• func MaxRequest(quantities ...resource.Quantity) resource.Quantity
• func MinLimit(quantities ...resource.Quantity) resource.Quantity

Variables

var ResourceQuantityCmp = cmp.Comparer(func(x, y resource.Quantity) bool {
	return x.Cmp(y) == 0
})

ResourceQuantityCmp allows resource quantities to be compared in tests

Functions

func EquateEmptyResourceList

func EquateEmptyResourceList() cmp.Option

EquateEmptyResourceList returns a comparison option that will equate resource lists if neither contains non-empty resource quantities.

func IsEmpty

func IsEmpty(x corev1.ResourceList) bool

IsEmpty returns false if the ResourceList contains non-empty resource quantities.

func IsZero

func IsZero(q resource.Quantity) bool

IsZero returns true if the resource quantity has a zero value

func MaxRequest

func MaxRequest(quantities ...resource.Quantity) resource.Quantity

MaxRequest returns the largest resource request A zero request is considered the smallest request

func MinLimit

func MinLimit(quantities ...resource.Quantity) resource.Quantity

MinLimit returns the smallest resource limit A zero limit is considered higher than any other resource limit.