plugin

package
v0.4.1-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 3, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrContentLocationNotFound = fmt.Errorf("content location not found")

Functions

This section is empty.

Types

type BoolData 

type BoolData bool

func (BoolData) Any 

func (d BoolData) Any() any

func (BoolData) AsJQData 

func (d BoolData) AsJQData() Data

type Content 

type Content interface {
	AsData() Data
	ID() uint32
	AsJQData() Data
	Meta() *ContentMeta
	Print() string
	// contains filtered or unexported methods
}

func ParseContentData added in v0.4.1 

func ParseContentData(data MapData) (Content, error)

type ContentElement added in v0.4.1 

type ContentElement struct {
	Markdown string
	// contains filtered or unexported fields
}

func (*ContentElement) AsData added in v0.4.1 

func (c *ContentElement) AsData() Data

func (*ContentElement) AsJQData added in v0.4.1 

func (c *ContentElement) AsJQData() Data

func (*ContentElement) ID added in v0.4.1 

func (c *ContentElement) ID() uint32

func (*ContentElement) Meta added in v0.4.1 

func (c *ContentElement) Meta() *ContentMeta

func (*ContentElement) Print added in v0.4.1 

func (c *ContentElement) Print() string

type ContentEmpty added in v0.4.1 

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

func (*ContentEmpty) AsData added in v0.4.1 

func (n *ContentEmpty) AsData() Data

func (*ContentEmpty) AsJQData added in v0.4.1 

func (n *ContentEmpty) AsJQData() Data

func (*ContentEmpty) ID added in v0.4.1 

func (n *ContentEmpty) ID() uint32

func (*ContentEmpty) Meta added in v0.4.1 

func (n *ContentEmpty) Meta() *ContentMeta

func (*ContentEmpty) Print added in v0.4.1 

func (n *ContentEmpty) Print() string

type ContentMeta added in v0.4.1 

type ContentMeta struct {
	Provider string
	Plugin   string
	Version  string
}

func ParseContentMeta added in v0.4.1 

func ParseContentMeta(data Data) *ContentMeta

func (*ContentMeta) AsData added in v0.4.1 

func (meta *ContentMeta) AsData() Data

type ContentProvider 

type ContentProvider struct {
	ContentFunc     ProvideContentFunc
	Args            hcldec.Spec
	Config          hcldec.Spec
	InvocationOrder InvocationOrder
}

func (*ContentProvider) Execute 

func (cg *ContentProvider) Execute(ctx context.Context, params *ProvideContentParams) (*ContentResult, hcl.Diagnostics)

func (*ContentProvider) Validate 

func (cg *ContentProvider) Validate() hcl.Diagnostics

type ContentProviders 

type ContentProviders map[string]*ContentProvider

func (ContentProviders) Validate 

func (cp ContentProviders) Validate() hcl.Diagnostics

type ContentResult added in v0.4.1 

type ContentResult struct {
	Location *Location
	Content  Content
}

type ContentSection added in v0.4.1 

type ContentSection struct {
	Children []Content
	// contains filtered or unexported fields
}

func (*ContentSection) Add added in v0.4.1 

func (c *ContentSection) Add(content Content, loc *Location) error

Add content to the content tree.

func (*ContentSection) AsData added in v0.4.1 

func (c *ContentSection) AsData() Data

AsData returns the content tree as a map.

func (*ContentSection) AsJQData added in v0.4.1 

func (c *ContentSection) AsJQData() Data

func (*ContentSection) Compact added in v0.4.1 

func (c *ContentSection) Compact()

Compact removes empty sections from the content tree.

func (*ContentSection) ID added in v0.4.1 

func (c *ContentSection) ID() uint32

func (*ContentSection) Meta added in v0.4.1 

func (c *ContentSection) Meta() *ContentMeta

func (*ContentSection) Print added in v0.4.1 

func (c *ContentSection) Print() string

Print returns the content tree as a string.

type ConvListData 

type ConvListData []ConvertableData

func (ConvListData) Any 

func (d ConvListData) Any() any

func (ConvListData) AsJQData 

func (d ConvListData) AsJQData() Data

type ConvMapData 

type ConvMapData map[string]ConvertableData

func (ConvMapData) Any 

func (d ConvMapData) Any() any

func (ConvMapData) AsJQData 

func (d ConvMapData) AsJQData() Data

type ConvertableData 

type ConvertableData interface {
	AsJQData() Data
}

type Data 

type Data interface {
	Any() any

	ConvertableData
	// contains filtered or unexported methods
}

func ParseDataAny 

func ParseDataAny(v any) (Data, error)

func UnmarshalJSONData 

func UnmarshalJSONData(data []byte) (Data, error)

type DataSource 

type DataSource struct {
	DataFunc RetrieveDataFunc
	Args     hcldec.Spec
	Config   hcldec.Spec
}

func (*DataSource) Execute 

func (ds *DataSource) Execute(ctx context.Context, params *RetrieveDataParams) (Data, hcl.Diagnostics)

func (*DataSource) Validate 

func (ds *DataSource) Validate() hcl.Diagnostics

type DataSources 

type DataSources map[string]*DataSource

func (DataSources) Validate 

func (ds DataSources) Validate() hcl.Diagnostics

type InvocationOrder added in v0.4.1 

type InvocationOrder int
const (
	InvocationOrderUnspecified InvocationOrder = iota
	InvocationOrderBegin
	InvocationOrderEnd
)

func (InvocationOrder) Weight added in v0.4.1 

func (order InvocationOrder) Weight() int

type ListData 

type ListData []Data

func (ListData) Any 

func (d ListData) Any() any

func (ListData) AsJQData 

func (d ListData) AsJQData() Data

type Location added in v0.4.1 

type Location struct {
	Index  uint32
	Effect LocationEffect
}

type LocationEffect added in v0.4.1 

type LocationEffect int
const (
	LocationEffectUnspecified LocationEffect = iota
	LocationEffectBefore
	LocationEffectAfter
)

type MapData 

type MapData map[string]Data

func ParseDataMapAny 

func ParseDataMapAny(v map[string]any) (MapData, error)

func (MapData) Any 

func (d MapData) Any() any

func (MapData) AsJQData 

func (d MapData) AsJQData() Data

type NumberData 

type NumberData float64

func (NumberData) Any 

func (d NumberData) Any() any

func (NumberData) AsJQData 

func (d NumberData) AsJQData() Data

type ProvideContentFunc 

type ProvideContentFunc func(ctx context.Context, params *ProvideContentParams) (*ContentResult, hcl.Diagnostics)

type ProvideContentParams 

type ProvideContentParams struct {
	Config      cty.Value
	Args        cty.Value
	DataContext MapData
	ContentID   uint32
}

type RetrieveDataFunc 

type RetrieveDataFunc func(ctx context.Context, params *RetrieveDataParams) (Data, hcl.Diagnostics)

type RetrieveDataParams 

type RetrieveDataParams struct {
	Config cty.Value
	Args   cty.Value
}

type Schema 

type Schema struct {
	Name             string
	Version          string
	DataSources      DataSources
	ContentProviders ContentProviders
}

func (*Schema) ProvideContent 

func (p *Schema) ProvideContent(ctx context.Context, name string, params *ProvideContentParams) (*ContentResult, hcl.Diagnostics)

func (*Schema) RetrieveData 

func (p *Schema) RetrieveData(ctx context.Context, name string, params *RetrieveDataParams) (Data, hcl.Diagnostics)

func (*Schema) Validate 

func (p *Schema) Validate() hcl.Diagnostics

type StringData 

type StringData string

func (StringData) Any 

func (d StringData) Any() any

func (StringData) AsJQData 

func (d StringData) AsJQData() Data

Source Files

View all Source files

Directories

Path Synopsis
pluginapi
v1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.