cloudlib

README

cloudlib

A "standard library" of go functions used to build portable cloud native apps

Documentation

Index

• Constants
• type GenericProvider
• type InstanceProviderFunc
• type Provider
  • func New(opts ...ProviderConfig) (*Provider, error)
  • func (p *Provider) Close() bool
  • func (p *Provider) Find(providerType ProviderType) (interface{}, bool)
  • func (p *Provider) RegisterProviders(ignoreExists bool, opts ...ProviderConfig) error
• type ProviderConfig
  • func WithProvider(ID string, providerType ProviderType, impl InstanceProviderFunc) ProviderConfig
• type ProviderType

Constants

const (
	MsgMissingProvider         = "provider '%s' required"
	MsgUnsupportedProviderType = "unsupported provider type '%d'"
)

Types

type GenericProvider

type GenericProvider interface {
	Close() error
}

type InstanceProviderFunc

type InstanceProviderFunc func() interface{}

type Provider

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

func New

func New(opts ...ProviderConfig) (*Provider, error)

New creates a new provider instance and configures it with provider implementations

func (*Provider) Close

func (p *Provider) Close() bool

Close iterates over all registered ProviderConfigs and asks them to 'close'

func (*Provider) Find

func (p *Provider) Find(providerType ProviderType) (interface{}, bool)

Find returns the registered provider instance if defined. The bool flag is set to true if there is a provider and false otherwise.

func (*Provider) RegisterProviders

func (p *Provider) RegisterProviders(ignoreExists bool, opts ...ProviderConfig) error

RegisterProviders registers one or more providers. An existing provider will be overwritten if ignoreExists is true, otherwise the function returns an error.

type ProviderConfig

type ProviderConfig struct {
	ID   string
	Type ProviderType
	Impl InstanceProviderFunc
}

func WithProvider

func WithProvider(ID string, providerType ProviderType, impl InstanceProviderFunc) ProviderConfig

WithProvider returns a populated ProviderConfig struct.

type ProviderType

type ProviderType int