entity

README

This package allows parsing entities from CUE fields with parsers that depend on the provided URL. Supported entity parsers need to be provided in advance.

Used for "integration" and "build" parsing.

Documentation

Index

• type DispatchingEntityParser
  • func NewDispatchingEntityParser(urlCueKey string, parsers []EntityParser) *DispatchingEntityParser
  • func (p *DispatchingEntityParser) ParseEntity(ctx context.Context, env *schema.Environment, pl parsing.EarlyPackageLoader, ...) (ParsedEntity, error)
• type EntityParser
• type ParsedEntity

Types

type DispatchingEntityParser

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

func NewDispatchingEntityParser

func NewDispatchingEntityParser(urlCueKey string, parsers []EntityParser) *DispatchingEntityParser

Calls one of the registered entityt parsers, repending on the value of the "urlCueKey" field.

func (*DispatchingEntityParser) ParseEntity

func (p *DispatchingEntityParser) ParseEntity(ctx context.Context, env *schema.Environment, pl parsing.EarlyPackageLoader, loc pkggraph.Location, v *fncue.CueV) (ParsedEntity, error)

type EntityParser

type EntityParser interface {
	// For example, "namespace.so/from-dockerfile"
	Url() string

	// Shortcut for "kind", for example, "docker"
	Shortcut() string

	// "v" is nil if the user used the shortest syntactic form. Example: `integration: "golang"`
	Parse(ctx context.Context, env *schema.Environment, pl parsing.EarlyPackageLoader, loc pkggraph.Location, v *fncue.CueV) (proto.Message, error)
}

type ParsedEntity

type ParsedEntity struct {
	Url  string
	Data proto.Message
}