README
¶
configfile
configfile implements configio interfaces for a file backend.
see tests for example use cases
Documentation
¶
Index ¶
- Constants
- func NewManager(ctx context.Context, options ...interface{}) (configio.ConfigManager, error)
- func NewManagerWithWatch(ctx context.Context, options ...interface{}) (configio.ConfigManagerWithWatch, error)
- func NewReader(ctx context.Context, options ...interface{}) (configio.ConfigReader, error)
- func NewWatcher(ctx context.Context, options ...interface{}) (configio.ConfigWatcher, error)
- func NewWriter(ctx context.Context, options ...interface{}) (configio.ConfigWriter, error)
Constants ¶
const (
OptFilePath = "file"
)
options here can be used during instantiation of new manager
Variables ¶
This section is empty.
Functions ¶
func NewManager ¶
func NewManager(ctx context.Context, options ...interface{}) (configio.ConfigManager, error)
NewManager returns instance of ConfigManager interface. ConfigManager should be used by clients who wish to read and write config and are not going to perform a watch
func NewManagerWithWatch ¶
func NewManagerWithWatch(ctx context.Context, options ...interface{}) (configio.ConfigManagerWithWatch, error)
NewManagerWithWatch returns instance of ConfigManagerWithWatch interface. ConfigManagerWithWatch should be used by clients requiring full config management features
func NewReader ¶
func NewReader(ctx context.Context, options ...interface{}) (configio.ConfigReader, error)
NewReader returns instance of ConfigReader interface. ConfigReader should be used by clients who just wish to read config and/or for clients who should be given read permissions only
func NewWatcher ¶
func NewWatcher(ctx context.Context, options ...interface{}) (configio.ConfigWatcher, error)
NewWatcher returns an instance of ConfigWatcher interface. ConfigWatcher should be used by clients who only wish to watch config changes
Types ¶
This section is empty.
Source Files