source

Documentation

Index

• Variables
• type Entry
  • func Parse(data []byte) []Entry
• type Source
  • func (s Source) Backend() (SourceBackend, error)
  • func (s Source) Load(ctx context.Context) ([]*SourceEntry, error)
  • func (s Source) Validate() error
• type SourceBackend
• type SourceEntry
  • func (e SourceEntry) Parse() ([]Entry, error)
• type SourceExec
  • func (s SourceExec) Load(ctx context.Context) ([]*SourceEntry, error)
  • func (s SourceExec) String() string
  • func (s SourceExec) Validate() error
• type SourceInline
  • func (s SourceInline) Load(ctx context.Context) ([]*SourceEntry, error)
  • func (s SourceInline) String() string
  • func (s SourceInline) Validate() error
• type SourceLocal
  • func (s SourceLocal) Load(ctx context.Context) ([]*SourceEntry, error)
  • func (s SourceLocal) String() string
  • func (s SourceLocal) Validate() error

Variables

var ErrInvalidSourceEmpty = fmt.Errorf("invalid source, must specify at least one type of source configuration")

Types

type Entry

type Entry map[string]any

Entry is a single sourced entry. It's just a basic map, but makes it much clearer when building lists of this type, as the type syntax can get a bit messy.

func Parse

func Parse(data []byte) []Entry

Parse attempts to extract entries from content that is either Jsonnet, JSON or YAML.

It also supports multidoc YAML, and will either return the root object itself if that root is a map[string]any, or if the root is an array, will try returning the contents of said array that are map[string]any's.

type Source

type Source struct {
	Local  *SourceLocal  `json:"local,omitempty"`
	Inline *SourceInline `json:"inline,omitempty"`
	Exec   *SourceExec   `json:"exec,omitempty"`
}

Source is instantiated from configuration and represents a source of catalog files.

func (Source) Backend

func (s Source) Backend() (SourceBackend, error)

func (Source) Load

func (s Source) Load(ctx context.Context) ([]*SourceEntry, error)

func (Source) Validate

func (s Source) Validate() error

type SourceBackend

type SourceBackend interface {
	String() string
	Load(ctx context.Context) ([]*SourceEntry, error)
}

type SourceEntry

type SourceEntry struct {
	Origin  string
	Content []byte
}

SourceEntry is an entry that has been discovered in a source, with the contents of the source file and an Origin that explains where the entry came from, specific to the type of source that produced it.

func (SourceEntry) Parse

func (e SourceEntry) Parse() ([]Entry, error)

type SourceExec

type SourceExec struct {
	Command []string `json:"command"`
}

func (SourceExec) Load

func (s SourceExec) Load(ctx context.Context) ([]*SourceEntry, error)

func (SourceExec) String

func (s SourceExec) String() string

func (SourceExec) Validate

func (s SourceExec) Validate() error

type SourceInline

type SourceInline struct {
	Entries []map[string]any `json:"entries"`
}

func (SourceInline) Load

func (s SourceInline) Load(ctx context.Context) ([]*SourceEntry, error)

func (SourceInline) String

func (s SourceInline) String() string

func (SourceInline) Validate

func (s SourceInline) Validate() error

type SourceLocal

type SourceLocal struct {
	Files []string `json:"files"`
}

func (SourceLocal) Load

func (s SourceLocal) Load(ctx context.Context) ([]*SourceEntry, error)

func (SourceLocal) String

func (s SourceLocal) String() string

func (SourceLocal) Validate

func (s SourceLocal) Validate() error