meta

Documentation

Overview

Package meta provides common meta types for config documents.

Index

• type Meta
  • func (m Meta) APIVersion() string
  • func (m Meta) Kind() string
• type URL
  • func (u URL) MarshalYAML() (any, error)
  • func (u *URL) UnmarshalYAML(unmarshal func(any) error) error

Types

type Meta

type Meta struct {
	MetaAPIVersion string `yaml:"apiVersion,omitempty"`
	MetaKind       string `yaml:"kind"`
}

Meta is a shared meta information for config documents.

func (Meta) APIVersion

func (m Meta) APIVersion() string

APIVersion implements config.Document interface.

func (Meta) Kind

func (m Meta) Kind() string

Kind implements config.Document interface.

type URL

type URL struct {
	*url.URL
}

URL wraps the URL with proper YAML marshal/unmarshal.

func (URL) MarshalYAML

func (u URL) MarshalYAML() (any, error)

MarshalYAML is a custom marshaller for `URL`.

func (*URL) UnmarshalYAML

func (u *URL) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML is a custom unmarshaller for `URL`.