contract

package

v0.3.0 Latest Latest Go to latest Published: Jun 24, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/k3s-io/cluster-api-k3s

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrFieldNotFound = errors.New("field not found")

ErrFieldNotFound is returned when a field is not found in the object.

Functions ¶

This section is empty.

Types ¶

type Bool ¶

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

Bool represents an accessor to an bool path value.

func (*Bool) Get ¶

func (b *Bool) Get(obj *unstructured.Unstructured) (*bool, error)

Get gets the bool value.

func (*Bool) Path ¶

func (b *Bool) Path() Path

Path returns the path to the bool value.

func (*Bool) Set ¶

func (b *Bool) Set(obj *unstructured.Unstructured, value bool) error

Set sets the bool value in the path.

type Duration ¶

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

Duration represents an accessor to a metav1.Duration path value.

func (*Duration) Get ¶

func (i *Duration) Get(obj *unstructured.Unstructured) (*metav1.Duration, error)

Get gets the metav1.Duration value.

func (*Duration) Path ¶

func (i *Duration) Path() Path

Path returns the path to the metav1.Duration value.

func (*Duration) Set ¶

func (i *Duration) Set(obj *unstructured.Unstructured, value metav1.Duration) error

Set sets the metav1.Duration value in the path.

type Int64 ¶

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

Int64 represents an accessor to an int64 path value.

func (*Int64) Get ¶

func (i *Int64) Get(obj *unstructured.Unstructured) (*int64, error)

Get gets the int64 value.

func (*Int64) Path ¶

func (i *Int64) Path() Path

Path returns the path to the int64 value.

func (*Int64) Set ¶

func (i *Int64) Set(obj *unstructured.Unstructured, value int64) error

Set sets the int64 value in the path.

type Path ¶

type Path []string

Path defines a how to access a field in an Unstructured object.

func (Path) Append ¶

func (p Path) Append(k string) Path

Append a field name to a path.

func (Path) Equal ¶

func (p Path) Equal(other Path) bool

Equal check if two path are equal (exact match).

func (Path) IsParentOf ¶

func (p Path) IsParentOf(other Path) bool

IsParentOf check if one path is Parent of the other.

func (Path) Overlaps ¶

func (p Path) Overlaps(other Path) bool

Overlaps return true if two paths are Equal or one IsParentOf the other.

func (Path) String ¶

func (p Path) String() string

String returns the path as a dotted string.

type String ¶

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

String represents an accessor to a string path value.

func (*String) Get ¶

func (s *String) Get(obj *unstructured.Unstructured) (*string, error)

Get gets the string value.

func (*String) Path ¶

func (s *String) Path() Path

Path returns the path to the string value.

func (*String) Set ¶

func (s *String) Set(obj *unstructured.Unstructured, value string) error

Set sets the string value in the path.

Source Files ¶

View all Source files

types.go

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