ingredient

Documentation

Index

• type Base
  • func (cb Base) Name() string
• type FetcherFlags
• type Ingredient
  • func Init(ingredient Ingredient, liquid *liquid.Liquid) Ingredient
• type WissKIFetcher

Types

type Base

type Base struct {
	*liquid.Liquid // the underlying liquid
	// contains filtered or unexported fields
}

Base is embedded into every Ingredient

func (Base) Name

func (cb Base) Name() string

type FetcherFlags

type FetcherFlags struct {
	Context context.Context
	Quick   bool
	Server  *phpx.Server
}

FetcherFlags describes options for a WissKIFetcher

type Ingredient

type Ingredient interface {
	// Name returns the name of this ingredient
	// Name should be implemented by the [Base] struct.
	Name() string
	// contains filtered or unexported methods
}

Ingredients represent a part of a WissKI instance. An Ingredient should be implemented as a pointer to a struct. Every ingredient must embed Base and should be initialized using Init inside a [lifetime.Lifetime].

By convention these are defined within their corresponding subpackage. This subpackage also contains all required resources.

func Init

func Init(ingredient Ingredient, liquid *liquid.Liquid) Ingredient

Init initializes a new Ingredient. Init is only intended to be used within a lifetime.Lifetime[Ingredient,*Liquid].

type WissKIFetcher

type WissKIFetcher interface {
	Ingredient

	// Fetch fetches information from this ingredient and writes it into target.
	// Distinct WissKIFetchers must write into distinct fields.
	Fetch(flags FetcherFlags, target *status.WissKI) error
}