providers

Documentation

Overview

Package providers exposes a small driver-style registry of provider constructors. It lets callers ask for a provider by name without hand-coding a switch over every shipped provider package.

Each provider sub-package registers itself in init() so importing `_ "github.com/erain/glue/providers/nvidia"` makes that provider resolvable via providers.New("nvidia"). The registry holds factory functions, not constructed providers, so registration is cheap and has no I/O or credential side effects.

Index

• func KeyAvailable(name string) bool
• func Known() []string
• func New(name string) (loop.Provider, string, string, error)
• func Register(name string, f Factory)
• type Factory
  • func Lookup(name string) (Factory, bool)

Functions

func KeyAvailable

func KeyAvailable(name string) bool

KeyAvailable reports whether the registered provider's env var is non-empty in the process environment. Returns false for unknown providers and for providers registered without an EnvKey.

func Known

func Known() []string

Known returns the registered provider names, sorted for stable output in error messages and CLI help text.

func New

func New(name string) (loop.Provider, string, string, error)

New constructs a fresh provider for the registered name. Returns the provider, its default model, the env var it consults, and an error if the name is unknown.

func Register

func Register(name string, f Factory)

Register adds a provider to the registry. Re-registering an existing name overwrites — driver-style packages may register from init() and the last importer wins.

Types

type Factory

type Factory struct {
	// New returns a fresh provider configured with package defaults
	// (no explicit API key — falls back to the provider's env var).
	New func() loop.Provider

	// DefaultModel is the model id callers should use when they have
	// no opinion. The registry exposes it so a CLI agent can present
	// `--model` defaults that vary by provider.
	DefaultModel string

	// EnvKey is the environment variable the provider reads when
	// APIKey is empty. Used by KeyAvailable.
	EnvKey string
}

Factory describes one registered provider.

func Lookup

func Lookup(name string) (Factory, bool)

Lookup returns the factory for name, or false if no provider is registered under that name.