platform

Documentation

Index

• Variables
• type Config
• type PlatformKind
• type Provider
  • func Initialize(container *ioc.NestedContainer, defaultPlatform PlatformKind) (Provider, error)

Variables

var (
	ErrPlatformNotSupported   = fmt.Errorf("unsupported platform")
	ErrPlatformConfigNotFound = fmt.Errorf("platform config not found")

	Error error = nil
)

Types

type Config

type Config struct {
	Type   PlatformKind   `yaml:"type"`
	Config map[string]any `yaml:"config"`
}

type PlatformKind

type PlatformKind string

type Provider

type Provider interface {
	// Name returns the name of the platform
	Name() string

	// IsEnabled returns true if the platform is enabled
	IsEnabled() bool

	// ConfigureContainer configures the IoC container for the platform
	ConfigureContainer(container *ioc.NestedContainer) error
}

Provider is an interface for a platform provider

func Initialize

func Initialize(container *ioc.NestedContainer, defaultPlatform PlatformKind) (Provider, error)

Initialize configures the IoC container with the platform specific components