config

Documentation

Overview

Package config defines standard interfaces for a config reader/writer.

Index

• type ReadOption
  • func WithFile(f string) ReadOption
  • func WithPrefix(prefix string) ReadOption
• type ReadOptions
  • func (op *ReadOptions) Apply(opts ...ReadOption)
• type Reader

Types

type ReadOption

type ReadOption func(o *ReadOptions)

ReadOption is a helper setting ReadOptions.

func WithFile

func WithFile(f string) ReadOption

WithFile is an option allow the reader read configuration from a file.

func WithPrefix

func WithPrefix(prefix string) ReadOption

WithPrefix return a with prefix reader option.

type ReadOptions

type ReadOptions struct {
	Prefix string
	File   string
}

ReadOptions contains available options of Reader interface.

func (*ReadOptions) Apply

func (op *ReadOptions) Apply(opts ...ReadOption)

Apply applies the given option.

type Reader

type Reader interface {
	// Read read the configuration into the given struct (ptr).
	// The provided struct should be a pointer.
	Read(ptr interface{}, options ...ReadOption) error

	// Close close the underlying source.
	Close() error
}

Reader is a configuration loader.