provider

package

v0.0.2 Latest Latest Go to latest Published: Jun 24, 2021 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/realnighthawk/bucky

Links

Open Source Insights

Documentation ¶

Overview ¶

Package provider provides config provider implementations that can be used in the adapters, as well as the Options type containing options for various aspects of an adapter.

Index ¶

Constants
func ErrGetObject(err error) error
func ErrSetObject(err error) error
func NewInMem(opts Options) (config.Handler, error)
func NewViper(opts Options) (config.Handler, error)
type InMem
type Options
type Viper

Constants ¶

View Source

const (
	// ViperKey corresponds to viper configuration
	ViperKey = "viper"
	// InMemKey corresponds to in memory configuration
	InMemKey = "in-memory"
)

View Source

const (
	// FilePath the path to store the config file
	FilePath = "filepath"
	// FileType the type of the config file
	FileType = "filetype"
	// FileName the name of the config file
	FileName = "filename"
)

Variables ¶

This section is empty.

Functions ¶

func ErrGetObject ¶

func ErrGetObject(err error) error

ErrGetObject returns error for get config

func ErrSetObject ¶

func ErrSetObject(err error) error

ErrSetObject returns error for set config

func NewInMem ¶

func NewInMem(opts Options) (config.Handler, error)

NewInMem returns a new instance of an in-memory configuration provider using the provided Options opts.

func NewViper ¶

func NewViper(opts Options) (config.Handler, error)

NewViper returns a new instance of a Viper configuration provider using the provided Options opts.

Types ¶

type InMem ¶

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

InMem implements the config interface Handler for an in-memory configuration registry.

func (*InMem) GetKey ¶

func (l *InMem) GetKey(key string) string

GetKey gets a key value from local store

func (*InMem) GetObject ¶

func (l *InMem) GetObject(key string, result interface{}) error

GetObject gets an object value for the key

func (*InMem) SetKey ¶

func (l *InMem) SetKey(key string, value string)

SetKey sets a key value in local store

func (*InMem) SetObject ¶

func (l *InMem) SetObject(key string, value interface{}) error

SetObject sets an object value for the key

type Options ¶

type Options struct {
	FilePath string
	FileType string
	FileName string
}

Options contains config options for various aspects of an adapter.

type Viper ¶

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

Viper implements the config interface Handler for a Viper configuration registry.

func (*Viper) GetKey ¶

func (v *Viper) GetKey(key string) string

GetKey implements GetKey functionality of the interface

func (*Viper) GetObject ¶

func (v *Viper) GetObject(key string, result interface{}) error

GetObject implements GetObject functionality of the interface

func (*Viper) SetKey ¶

func (v *Viper) SetKey(key string, value string)

SetKey implements SetKey functionality of the interface

func (*Viper) SetObject ¶

func (v *Viper) SetObject(key string, value interface{}) error

SetObject implements SetObject functionality of the interface

Source Files ¶

View all Source files

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