component

package

v1.3.2 Latest Latest Go to latest Published: Apr 30, 2024 License: LGPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Argus-Labs/world-engine

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NewComponentMetadata[T types.Component](opts ...Option[T]) (types.ComponentMetadata, error)
type Manager
- func NewManager(schemaStorage SchemaStorage) *Manager
type Option
- func WithDefault[T types.Component](defaultVal T) Option[T]
type SchemaStorage

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrComponentNotRegistered = eris.New("component not registered")

Functions ¶

func NewComponentMetadata ¶

func NewComponentMetadata[T types.Component](opts ...Option[T]) (
	types.ComponentMetadata, error,
)

NewComponentMetadata creates a new component type. The function is used to create a new component of the type.

Types ¶

type Manager ¶

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

func NewManager ¶

func NewManager(schemaStorage SchemaStorage) *Manager

NewManager creates a new component manager.

func (*Manager) GetComponentByName ¶

func (m *Manager) GetComponentByName(name string) (types.ComponentMetadata, error)

GetComponentByName returns the component metadata for the given component name.

func (*Manager) GetComponents ¶

func (m *Manager) GetComponents() []types.ComponentMetadata

GetComponents returns a list of all registered components. Note: The order of the components in the list is not deterministic.

func (*Manager) RegisterComponent ¶

func (m *Manager) RegisterComponent(compMetadata types.ComponentMetadata) error

RegisterComponent registers component with the component manager. There can only be one component with a given name, which is declared by the user by implementing the Name() method. If there is a duplicate component name, an error will be returned and the component will not be registered.

type Option ¶

type Option[T types.Component] func(c *componentMetadata[T])

Option is a type that can be passed to NewComponentMetadata to augment the creation of the component type.

func WithDefault ¶

func WithDefault[T types.Component](defaultVal T) Option[T]

WithDefault updated the created componentMetadata with a default value.

type SchemaStorage ¶

type SchemaStorage interface {
	GetSchema(componentName string) ([]byte, error)
	SetSchema(componentName string, schemaData []byte) error
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL