32 lines
1.1 KiB
Go
32 lines
1.1 KiB
Go
// Package component holds the main abstraction for components.
|
|
package component
|
|
|
|
// Component represents a logical subsystem of the distillery.
|
|
// Every component must embed [ComponentBase] and should be initialized using [Initialize].
|
|
//
|
|
// By convention these are defined within their corresponding subpackage.
|
|
// This subpackage also contains all required resources.
|
|
// Furthermore, a component is typically instantiated using a call on the ["distillery.Distillery"] struct.
|
|
//
|
|
// For example, the web.Web component lives in the web package and can be created like:
|
|
//
|
|
// var dis Distillery
|
|
// web := dis.Web()
|
|
type Component interface {
|
|
// Name returns the name of this component.
|
|
// It should correspond to the appropriate subpackage.
|
|
Name() string
|
|
|
|
// getBase returns the embedded ComponentBase struct.
|
|
getBase() *ComponentBase
|
|
}
|
|
|
|
// ComponentBase should be embedded into every component
|
|
type ComponentBase struct {
|
|
Core // the core of the associated distillery
|
|
}
|
|
|
|
//lint:ignore U1000 used to implement the private methods of [Component]
|
|
func (cb *ComponentBase) getBase() *ComponentBase {
|
|
return cb
|
|
}
|