modulekit

Documentation

Index

• type APIHandlerInitializer
• type APIRoute
• type CLICommand
• type ModelModule
• type ModuleEntry
• type OperationProcessors
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) AddAPIHandlers(moduleID string, handlers ...APIHandlerInitializer) error
  • func (r *Registry) AddAPIRoutes(moduleID string, routes ...APIRoute) error
  • func (r *Registry) AddCLICommands(moduleID string, commands ...CLICommand) error
  • func (r *Registry) AddHinters(moduleID string, details ...encoder.DecodeDetail) error
  • func (r *Registry) AddOperationProcessors(moduleID string, processors ...OperationProcessors) error
  • func (r *Registry) AddSupportedFacts(moduleID string, details ...encoder.DecodeDetail) error
  • func (r *Registry) Entries() []ModuleEntry
  • func (r *Registry) Module(id string) (ModuleEntry, bool)
  • func (r *Registry) ModuleIDs() []string
  • func (r *Registry) Register(module ModelModule) error
  • func (r *Registry) ValidateModuleContract(id string) error

Types

type APIHandlerInitializer

type APIHandlerInitializer struct {
	Key      string
	Register func(*apic.Handlers, bool)
}

type APIRoute

type APIRoute struct {
	Path    string
	Methods []string
}

type CLICommand

type CLICommand struct {
	Key         string
	Description string
}

type ModelModule

type ModelModule interface {
	ID() string
	Register(*Registry) error
}

type ModuleEntry

type ModuleEntry struct {
	ID                  string
	Hinters             []encoder.DecodeDetail
	SupportedFacts      []encoder.DecodeDetail
	OperationProcessors []OperationProcessors
	APIRoutes           []APIRoute
	APIHandlers         []APIHandlerInitializer
	CLICommands         []CLICommand
}

type OperationProcessors

type OperationProcessors struct {
	Name      ps.Name
	Func      ps.Func
	SupportsA bool
	SupportsB bool
}

type Registry

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

func NewRegistry

func NewRegistry() *Registry

func (*Registry) AddAPIHandlers

func (r *Registry) AddAPIHandlers(moduleID string, handlers ...APIHandlerInitializer) error

func (*Registry) AddAPIRoutes

func (r *Registry) AddAPIRoutes(moduleID string, routes ...APIRoute) error

func (*Registry) AddCLICommands

func (r *Registry) AddCLICommands(moduleID string, commands ...CLICommand) error

func (*Registry) AddHinters

func (r *Registry) AddHinters(moduleID string, details ...encoder.DecodeDetail) error

func (*Registry) AddOperationProcessors

func (r *Registry) AddOperationProcessors(moduleID string, processors ...OperationProcessors) error

func (*Registry) AddSupportedFacts

func (r *Registry) AddSupportedFacts(moduleID string, details ...encoder.DecodeDetail) error

func (*Registry) Entries

func (r *Registry) Entries() []ModuleEntry

func (*Registry) Module

func (r *Registry) Module(id string) (ModuleEntry, bool)

func (*Registry) ModuleIDs

func (r *Registry) ModuleIDs() []string

func (*Registry) Register

func (r *Registry) Register(module ModelModule) error

func (*Registry) ValidateModuleContract

func (r *Registry) ValidateModuleContract(id string) error