pkgio

Documentation

Index

• Constants
• Variables
• type Data
  • func NewData() *Data
  • func (r *Data) Add(name string, b []byte)
  • func (r *Data) Delete(name string)
  • func (r *Data) Exists(name string) bool
  • func (r *Data) Get(name string) ([]byte, error)
  • func (r *Data) List() map[string]string
  • func (r *Data) Print()
  • func (r *Data) Update(name string, b []byte)
• type Pipeline
  • func (r Pipeline) Execute(ctx context.Context) error
• type PkgBuildReadWriter
  • func NewPkgBuildReadWriter(path string) PkgBuildReadWriter
• type PkgInitReadWriter
  • func NewPkgInitReadWriter(path string, pkgKind kformpkgmetav1alpha1.PkgKind, dirs []string) PkgInitReadWriter
• type PkgKformInitReader
  • func NewPkgKformInitReadWriter(path string) PkgKformInitReader
• type PkgProviderReadWriter
  • func NewPkgProviderReadWriter(rootPath string, providers cache.Cache[*address.Package]) PkgProviderReadWriter
• type PkgPushReadWriter
  • func NewPkgPushReadWriter(path, tag string) PkgPushReadWriter
• type PkgReader
  • func (r *PkgReader) Read(ctx context.Context, data *Data) (*Data, error)
  • func (r *PkgReader) Write(*Data) error
• type PkgTreeReadWriter
  • func NewPkgTreeReadWriter(path string) PkgTreeReadWriter
• type PkgValidator
  • func NewPkgValidator() PkgValidator
• type Process
• type Reader
• type Writer

Constants

const (
	// TreeStructurePackage configures TreeWriter to generate the tree structure off of the
	// packages.
	//TreeStructurePackage TreeStructure = "directory"
	// %q holds the package name
	PkgNameFormat = "Package %q"
)

Variables

var IgnoreFileMatch = []string{".kformignore"}

var JSONMatch = []string{"*.json"}

var MarkdownMatch = []string{"*.md"}

var PkgFileMatch = []string{"KformFile.yaml"}

var PkgMatch = []string{fmt.Sprintf("*.%s", kformOciPkgExt)}

var ReadmeFileMatch = []string{"README.md"}

var YAMLMatch = []string{"*.yaml", "*.yml"}

Types

type Data

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

func NewData

func NewData() *Data

func (*Data) Add

func (r *Data) Add(name string, b []byte)

func (*Data) Delete

func (r *Data) Delete(name string)

func (*Data) Exists

func (r *Data) Exists(name string) bool

func (*Data) Get

func (r *Data) Get(name string) ([]byte, error)

func (*Data) List

func (r *Data) List() map[string]string

func (*Data) Print

func (r *Data) Print()

func (*Data) Update

func (r *Data) Update(name string, b []byte)

type Pipeline

type Pipeline struct {
	Inputs     []Reader  `json:"inputs,omitempty" yaml:"inputs,omitempty"`
	Processors []Process `json:"processors,omitempty" yaml:"processors,omitempty"`
	Outputs    []Writer  `json:"outputs,omitempty" yaml:"outputs,omitempty"`
}

func (Pipeline) Execute

func (r Pipeline) Execute(ctx context.Context) error

type PkgBuildReadWriter

type PkgBuildReadWriter interface {
	Reader
	Writer
}

func NewPkgBuildReadWriter

func NewPkgBuildReadWriter(path string) PkgBuildReadWriter

type PkgInitReadWriter

type PkgInitReadWriter interface {
	Reader
	Writer
}

func NewPkgInitReadWriter

func NewPkgInitReadWriter(path string, pkgKind kformpkgmetav1alpha1.PkgKind, dirs []string) PkgInitReadWriter

type PkgKformInitReader

type PkgKformInitReader interface {
	Reader
}

func NewPkgKformInitReadWriter

func NewPkgKformInitReadWriter(path string) PkgKformInitReader

type PkgProviderReadWriter

type PkgProviderReadWriter interface {
	Reader
	Writer
	Process
}

func NewPkgProviderReadWriter

func NewPkgProviderReadWriter(rootPath string, providers cache.Cache[*address.Package]) PkgProviderReadWriter

type PkgPushReadWriter

type PkgPushReadWriter interface {
	Reader
	Writer
}

func NewPkgPushReadWriter

func NewPkgPushReadWriter(path, tag string) PkgPushReadWriter

type PkgReader

type PkgReader struct {
	PathExists     bool
	Fsys           fsys.FS
	MatchFilesGlob []string
	IgnoreRules    *ignore.Rules
	SkipDir        bool
	Checksum       bool
}

func (*PkgReader) Read

func (r *PkgReader) Read(ctx context.Context, data *Data) (*Data, error)

func (*PkgReader) Write

func (r *PkgReader) Write(*Data) error

type PkgTreeReadWriter

type PkgTreeReadWriter interface {
	Reader
	Writer
}

func NewPkgTreeReadWriter

func NewPkgTreeReadWriter(path string) PkgTreeReadWriter

type PkgValidator

type PkgValidator interface {
	Writer
}

func NewPkgValidator

func NewPkgValidator() PkgValidator

type Process

type Process interface {
	Process(context.Context, *Data) (*Data, error)
}

type Reader

type Reader interface {
	Read(context.Context, *Data) (*Data, error)
}

type Writer

type Writer interface {
	Write(context.Context, *Data) error
}