pkgio

Documentation

Index

• Variables
• func SplitDocuments(s string) ([]string, error)
• type ByteReader
  • func (r *ByteReader) Read(ctx context.Context) (store.Storer[[]byte], error)
• type ByteWriter
  • func (r *ByteWriter) Write(ctx context.Context, datastore store.Storer[[]byte]) error
• type DirReader
  • func (r *DirReader) Read(ctx context.Context) (store.Storer[[]byte], error)
• type FileReader
  • func (r *FileReader) Read(ctx context.Context) (store.Storer[[]byte], error)
• type GitReader
  • func (r *GitReader) Read(ctx context.Context) (store.Storer[[]byte], error)
• type GitWriter
  • func (r *GitWriter) Write(ctx context.Context, datastore store.Storer[[]byte]) error
• type InventoryReader
  • func (r *InventoryReader) Read(ctx context.Context, inv *invv1alpha1.Inventory) (store.Storer[[]byte], error)
• type KformDirReader
  • func (r *KformDirReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)
• type KformFileReader
  • func (r *KformFileReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)
• type KformMemReader
  • func (r *KformMemReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)
• type KformStreamReader
  • func (r *KformStreamReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)
• type KformWriter
  • func (r *KformWriter) Write(ctx context.Context, datastore store.Storer[data.BlockData]) error
• type MatchFilesGlob
• type OutputSink
• type Process
• type Reader
• type Writer
• type YAMLReader
  • func (r *YAMLReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)
• type YAMLWriter
  • func (r *YAMLWriter) Write(ctx context.Context, datastore store.Storer[*yaml.RNode]) error

Variables

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

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

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

var MatchAll = []string{"*"}

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

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

Functions

func SplitDocuments

func SplitDocuments(s string) ([]string, error)

splitDocuments returns a slice of all documents contained in a YAML string. Multiple documents can be divided by the YAML document separator (---). It allows for white space and comments to be after the separator on the same line, but will return an error if anything else is on the line.

Types

type ByteReader

type ByteReader struct {
	Reader io.Reader

	// allows the consumer to specify its own data store
	DataStore store.Storer[[]byte]

	// Path of the file the user is reading
	Path string
}

func (*ByteReader) Read

func (r *ByteReader) Read(ctx context.Context) (store.Storer[[]byte], error)

type ByteWriter

type ByteWriter struct {
	Type OutputSink
	// Could be a file or directory
	Path string
}

func (*ByteWriter) Write

func (r *ByteWriter) Write(ctx context.Context, datastore store.Storer[[]byte]) error

type DirReader

type DirReader struct {
	Path           string // dir
	Fsys           fsys.FS
	MatchFilesGlob MatchFilesGlob
	IgnoreRules    *ignore.Rules
	SkipDir        bool
	Checksum       bool
}

func (*DirReader) Read

func (r *DirReader) Read(ctx context.Context) (store.Storer[[]byte], error)

type FileReader

type FileReader struct {
	FileName string
	Fsys     fsys.FS
	Checksum bool
}

func (*FileReader) Read

func (r *FileReader) Read(ctx context.Context) (store.Storer[[]byte], error)

type GitReader

type GitReader struct {
	// URL of the Git Repository
	URL string
	// Secret with crendentials to access the repo
	Secret string
	// Deployment determines if this is a catalog repo or not
	Deployment bool
	// Directory used in the git repository as an offset
	Directory string
	// PackageID identifies target, repo, realm, package, workspace and revision (if assigned)
	PkgID *pkgid.PackageID
	// PkgPath identifies the localation of the package in the local filesystem
	PkgPath string
	// allows the consumer to specify its own data store
	DataStore store.Storer[[]byte]
}

func (*GitReader) Read

func (r *GitReader) Read(ctx context.Context) (store.Storer[[]byte], error)

type GitWriter

type GitWriter struct {
	// URL of the Git Repository
	URL string
	// Secret with crendentials to access the repo
	Secret string
	// Deployment determines if this is a catalog repo or not
	Deployment bool
	// Directory used in the git repository as an offset
	Directory string
	// PackageID identifies target, repo, realm, package, workspace and revision (if assigned)
	PkgID *pkgid.PackageID
	// PkgPath identifies the localation of the package in the local filesystem
	PkgPath string
}

func (*GitWriter) Write

func (r *GitWriter) Write(ctx context.Context, datastore store.Storer[[]byte]) error

type InventoryReader

type InventoryReader struct {
}

func (*InventoryReader) Read

func (r *InventoryReader) Read(ctx context.Context, inv *invv1alpha1.Inventory) (store.Storer[[]byte], error)

type KformDirReader

type KformDirReader struct {
	Path  string
	Input bool
}

func (*KformDirReader) Read

func (r *KformDirReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)

type KformFileReader

type KformFileReader struct {
	Path  string
	Input bool
}

func (*KformFileReader) Read

func (r *KformFileReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)

type KformMemReader

type KformMemReader struct {
	Resources map[string]string
	Data      store.Storer[[]byte]
	Input     bool
}

func (*KformMemReader) Read

func (r *KformMemReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)

type KformStreamReader

type KformStreamReader struct {
	Reader io.Reader
	Input  bool
}

func (*KformStreamReader) Read

func (r *KformStreamReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)

type KformWriter

type KformWriter struct {
	//Writer io.Writer
	Type OutputSink
	// Could be a file or directory
	Path string
}

func (*KformWriter) Write

func (r *KformWriter) Write(ctx context.Context, datastore store.Storer[data.BlockData]) error

type MatchFilesGlob

type MatchFilesGlob []string

type OutputSink

type OutputSink int64

const (
	OutputSink_None OutputSink = iota
	OutputSink_File
	OutputSink_FileRetain
	OutputSink_Dir
	OutputSink_StdOut
	OutputSink_Memory
)

type Process

type Process[T1 any] interface {
	Process(context.Context, store.Storer[T1]) (store.Storer[T1], error)
}

type Reader

type Reader[T1 any] interface {
	Read(context.Context) (store.Storer[T1], error)
}

type Writer

type Writer[T1 any] interface {
	Write(context.Context, store.Storer[T1]) error
}

type YAMLReader

type YAMLReader struct {
	Reader io.Reader

	// Path of the file the user is reading
	Path string

	// Client supplied annotations
	Annotations map[string]string

	// allows the consumer to specify its own data store
	DataStore store.Storer[*yaml.RNode]
}

func (*YAMLReader) Read

func (r *YAMLReader) Read(ctx context.Context) (store.Storer[*yaml.RNode], error)

type YAMLWriter

type YAMLWriter struct {
	Writer io.Writer

	Type OutputSink
	// Could be a file or directory
	Path string
}

func (*YAMLWriter) Write

func (r *YAMLWriter) Write(ctx context.Context, datastore store.Storer[*yaml.RNode]) error