config

Documentation

Index

• func DefaultConfigDir(name string) (string, error)
• func DefaultJoinPath(profile string, paths ...string) string
• func DefaultWriteFile(path string) error
• func WithDefaultFunction(writefile func(path string) error) func(*Config)
• func WithDirFunction(dir func(name string) (string, error)) func(*Config)
• func WithMarshalUnmarshaller(m MarshalUnmarshaller) func(*Config)
• func WithProfile(profile string) func(*Config)
• type Config
  • func New(name string, ops ...func(*Config)) *Config
  • func (c *Config) Load(name string, ob interface{}) error
  • func (c *Config) Save(name string, ob interface{}) error
• type JSONModule
  • func (m *JSONModule) Marshal(w io.Writer, ob interface{}) error
  • func (m *JSONModule) Unmarshal(r io.Reader, ob interface{}) error
• type MarshalUnmarshaller
• type Marshaller
• type Unmarshaller

Functions

func DefaultConfigDir

func DefaultConfigDir(name string) (string, error)

DefaultConfigDir :

func DefaultJoinPath

func DefaultJoinPath(profile string, paths ...string) string

DefaultJoinPath :

func DefaultWriteFile

func DefaultWriteFile(path string) error

DefaultWriteFile :

func WithDefaultFunction

func WithDefaultFunction(writefile func(path string) error) func(*Config)

WithDefaultFunction :

func WithDirFunction

func WithDirFunction(dir func(name string) (string, error)) func(*Config)

WithDirFunction :

func WithMarshalUnmarshaller

func WithMarshalUnmarshaller(m MarshalUnmarshaller) func(*Config)

WithMarshalUnmarshaller :

func WithProfile

func WithProfile(profile string) func(*Config)

WithProfile :

Types

type Config

type Config struct {
	Name     string
	Profile  string // optional
	M        MarshalUnmarshaller
	JoinPath func(profile string, paths ...string) string
	Default  func(path string) error
	Dir      func(name string) (string, error)
}

Config :

func New

func New(name string, ops ...func(*Config)) *Config

New :

func (*Config) Load

func (c *Config) Load(name string, ob interface{}) error

Load :

func (*Config) Save

func (c *Config) Save(name string, ob interface{}) error

Save :

type JSONModule

type JSONModule struct {
}

JSONModule :

func (*JSONModule) Marshal

func (m *JSONModule) Marshal(w io.Writer, ob interface{}) error

Marshal :

func (*JSONModule) Unmarshal

func (m *JSONModule) Unmarshal(r io.Reader, ob interface{}) error

Unmarshal :

type MarshalUnmarshaller

type MarshalUnmarshaller interface {
	Marshaller
	Unmarshaller
}

MarshalUnmarshaller :

type Marshaller

type Marshaller interface {
	Marshal(w io.Writer, ob interface{}) error
}

Marshaller :

type Unmarshaller

type Unmarshaller interface {
	Unmarshal(r io.Reader, ob interface{}) error
}

Unmarshaller :