util

Documentation

Index

• Constants
• func AddGroup(cmd *cobra.Command, id string, title string, groupCmds ...*cobra.Command)
• func Age(t, currentTime time.Time) string
• func AnySet(ss ...string) bool
• func AnyToAnySlice(a any) []any
• func AnyToStringSlice(a any) []string
• func ChainRunE(fns ...func(cmd *cobra.Command, args []string) error) func(cmd *cobra.Command, args []string) error
• func Datetime(t time.Time) string
• func DescribeDeprecation(resource hcloud.Deprecatable) string
• func DescribeFormat(w io.Writer, object interface{}, format string) error
• func DescribeJSON(w io.Writer, object interface{}) error
• func DescribeYAML(w io.Writer, object interface{}) error
• func ExactlyOneSet(s string, ss ...string) bool
• func FilterNil[T any](values []T) []T
• func GrossPrice(price hcloud.Price) string
• func IsNil(v any) bool
• func LabelsToString(labels map[string]string) string
• func ListLongDescription(intro string, columns []string) string
• func NA(s string) string
• func ParseBoolLenient(s string) (bool, error)
• func PrefixLines(text, prefix string) string
• func RemoveDuplicates[S ~[]E, E cmp.Ordered](values S) S
• func SliceDiff[S ~[]E, E cmp.Ordered](a, b []E) []E
• func SplitLabel(label string) []string
• func SplitLabelVars(label string) (string, string)
• func ToAnySlice[T any](a []T) []any
• func ToBoolE(val any) (bool, error)
• func ToKebabCase(s string) string
• func ToStringSlice(a []any) []string
• func ToStringSliceDelimited(val any) []string
• func Validate(cmd *cobra.Command, args []string) error
• func ValidateLenient(cmd *cobra.Command, args []string) error
• func ValidateRequiredFlags(flags *pflag.FlagSet, names ...string) error
• func Wrap(key string, value any) map[string]any
• func YesNo(b bool) string
• type ResourceState

Constants

const (
	Byte     = 1
	Kibibyte = Byte * 1024
	Mebibyte = Kibibyte * 1024
	Gibibyte = Mebibyte * 1024
	Tebibyte = Gibibyte * 1024
)

Functions

func AddGroup

func AddGroup(cmd *cobra.Command, id string, title string, groupCmds ...*cobra.Command)

AddGroup adds a group to the passed command and adds the passed commands to the group.

func Age

func Age(t, currentTime time.Time) string

func AnySet

func AnySet(ss ...string) bool

func AnyToAnySlice

func AnyToAnySlice(a any) []any

func AnyToStringSlice

func AnyToStringSlice(a any) []string

func ChainRunE

func ChainRunE(fns ...func(cmd *cobra.Command, args []string) error) func(cmd *cobra.Command, args []string) error

func Datetime

func Datetime(t time.Time) string

func DescribeDeprecation

func DescribeDeprecation(resource hcloud.Deprecatable) string

func DescribeFormat

func DescribeFormat(w io.Writer, object interface{}, format string) error

func DescribeJSON

func DescribeJSON(w io.Writer, object interface{}) error

func DescribeYAML

func DescribeYAML(w io.Writer, object interface{}) error

func ExactlyOneSet

func ExactlyOneSet(s string, ss ...string) bool

func FilterNil

func FilterNil[T any](values []T) []T

func GrossPrice

func GrossPrice(price hcloud.Price) string

func IsNil

func IsNil(v any) bool

func LabelsToString

func LabelsToString(labels map[string]string) string

func ListLongDescription

func ListLongDescription(intro string, columns []string) string

func NA

func NA(s string) string

func ParseBoolLenient

func ParseBoolLenient(s string) (bool, error)

ParseBoolLenient parses the passed string as a boolean. It is different from strconv.ParseBool in that it is case-insensitive and also accepts "yes"/"y" and "no"/"n" as valid values.

func PrefixLines

func PrefixLines(text, prefix string) string

PrefixLines will prefix all individual lines in the text with the passed prefix.

func RemoveDuplicates

func RemoveDuplicates[S ~[]E, E cmp.Ordered](values S) S

RemoveDuplicates removes duplicates from the passed slice while preserving the order of the elements. The first occurrence of an element is kept, all following occurrences are removed.

func SliceDiff

func SliceDiff[S ~[]E, E cmp.Ordered](a, b []E) []E

SliceDiff returns the difference between the two passed slices. The returned slice contains all elements that are present in a but not in b. The order of a is preserved.

func SplitLabel

func SplitLabel(label string) []string

func SplitLabelVars

func SplitLabelVars(label string) (string, string)

SplitLabelVars splits up label into key and value and returns them as separate return values. If label doesn't contain the `=` separator, SplitLabelVars returns the original string as key, with an empty value.

func ToAnySlice

func ToAnySlice[T any](a []T) []any

func ToBoolE

func ToBoolE(val any) (bool, error)

ToBoolE converts the provided value to a bool. It is more lenient than cast.ToBoolE (see ParseBoolLenient).

func ToKebabCase

func ToKebabCase(s string) string

ToKebabCase converts the passed string to kebab-case.

func ToStringSlice

func ToStringSlice(a []any) []string

func ToStringSliceDelimited

func ToStringSliceDelimited(val any) []string

ToStringSliceDelimited is like AnyToStringSlice but also accepts a string that is comma-separated.

func Validate

func Validate(cmd *cobra.Command, args []string) error

Validate checks if the number of positional arguments matches the usage string of a cobra.Command. It returns an error if the number of arguments does not match the usage string (if it is not variadic) or if an argument is missing. If your command usage has optional positional arguments, use ValidateLenient instead.

func ValidateLenient

func ValidateLenient(cmd *cobra.Command, args []string) error

ValidateLenient checks if the number of positional arguments matches the usage string of a cobra.Command. In contrast to Validate, it does not return an error if there are more arguments than expected. This can be useful for commands that have optional positional arguments.

func ValidateRequiredFlags

func ValidateRequiredFlags(flags *pflag.FlagSet, names ...string) error

ValidateRequiredFlags ensures that flags has values for all flags with the passed names.

This function duplicates the functionality cobra provides when calling MarkFlagRequired. However, in some cases a flag cannot be marked as required in cobra, for example when it depends on other flags. In those cases this function comes in handy.

func Wrap

func Wrap(key string, value any) map[string]any

Wrap wraps the passed value in a map with the passed key.

This is useful when working with JSON objects.

func YesNo

func YesNo(b bool) string

Types

type ResourceState

type ResourceState struct {
	IDOrName string
	Error    error
}