fields

package
v1.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Deprecation added in v1.10.0

type Deprecation struct {
	// Since denotes from which version the field is flagged as deprecated
	Since string
	// Field represents the field by which the deprecated field is superseded
	Field Field
}

Deprecation specifies field deprecation info.

func IsDeprecated added in v1.10.0

func IsDeprecated(f Field) (bool, *Deprecation)

IsDeprecated determines if the given field is deprecated.

type FieldInfo

type FieldInfo struct {
	Field       Field
	Desc        string
	Type        kparams.Type
	Examples    []string
	Deprecation *Deprecation
}

FieldInfo is the field metadata descriptor.

func Get

func Get() []FieldInfo

Get returns a slice of field information.

func (FieldInfo) IsDeprecated added in v1.10.0

func (f FieldInfo) IsDeprecated() bool

IsDeprecated determines if the field is deprecated.

Jump to

Keyboard shortcuts

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