source

Documentation

Overview

Package source defines the base types and structures of all configuration source functionalities.

Index

• Constants
• type BaseSource
  • func (s *BaseSource) Get(path string, def ...interface{}) (interface{}, error)
  • func (s *BaseSource) Has(path string) bool

Constants

const (
	// ID is the base application container registration string
	// for all configuration source services.
	ID = config.ID + ".source"
)

Types

type BaseSource

type BaseSource struct {
	Mutex  sync.Locker
	Config config.Config
}

BaseSource defines a config source that read a file content and stores its config contents to be used as a config.

func (*BaseSource) Get

func (s *BaseSource) Get(
	path string,
	def ...interface{},
) (interface{}, error)

Get will retrieve the value stored in the requested path present in the configuration content. If the path does not exist, then the value nil will be returned. This method will mostly be used by the config object to obtain the full content of the source to aggregate all the data into his internal storing config instance.

func (*BaseSource) Has

func (s *BaseSource) Has(
	path string,
) bool

Has will check if the requested path is present in the source configuration content.