Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

settings

package module

Go to main page

Versions in this module

v2

v2.0.4

Mar 2, 2026

v2.0.3

May 21, 2025

v2.0.2

Dec 18, 2024

v2.0.1

Aug 22, 2024

Changes in this version

+ func ExampleEnvGroups(groups []Group) string

+ func ExampleEnvSettings(settings []Setting) string

+ func ExampleYamlGroups(gs []Group) string

+ func ExampleYamlSettings(settings []Setting) string

+ func Load(ctx context.Context, s Source, settings []Setting) error

+ func LoadGroups(ctx context.Context, s Source, groups []Group) error

+ func NewComponent(ctx context.Context, s Source, v interface{}, destination interface{}) error

+ func VerifyComponent(v interface{}) error

+ type BaseSetting struct

+ DescriptionValue string

+ NameValue string

+ func (s *BaseSetting) Description() string

+ func (s *BaseSetting) Name() string

+ type BoolSetting struct

+ BoolValue *bool

+ func NewBoolSetting(name string, description string, fallback bool) *BoolSetting

+ func (s *BoolSetting) SetValue(v interface{}) error

+ func (s *BoolSetting) Value() interface{}

+ type BoolSliceSetting struct

+ BoolSliceValue *[]bool

+ func NewBoolSliceSetting(name string, description string, fallback []bool) *BoolSliceSetting

+ func (s *BoolSliceSetting) SetValue(v interface{}) error

+ func (s *BoolSliceSetting) Value() interface{}

+ type DurationSetting struct

+ DurationValue *time.Duration

+ func NewDurationSetting(name string, description string, fallback time.Duration) *DurationSetting

+ func (s *DurationSetting) SetValue(v interface{}) error

+ func (s *DurationSetting) Value() interface{}

+ type DurationSliceSetting struct

+ DurationSliceValue *[]time.Duration

+ func NewDurationSliceSetting(name string, description string, fallback []time.Duration) *DurationSliceSetting

+ func (s *DurationSliceSetting) SetValue(v interface{}) error

+ func (s *DurationSliceSetting) Value() interface{}

+ type Float32Setting struct

+ Float32Value *float32

+ func NewFloat32Setting(name string, description string, fallback float32) *Float32Setting

+ func (s *Float32Setting) SetValue(v interface{}) error

+ func (s *Float32Setting) Value() interface{}

+ type Float64Setting struct

+ Float64Value *float64

+ func NewFloat64Setting(name string, description string, fallback float64) *Float64Setting

+ func (s *Float64Setting) SetValue(v interface{}) error

+ func (s *Float64Setting) Value() interface{}

+ type Group interface

+ Description func() string

+ Groups func() []Group

+ Name func() string

+ Settings func() []Setting

+ func Convert(v interface{}) (Group, error)

+ func GroupFromComponent(v interface{}) (Group, error)

+ type Int16Setting struct

+ Int16Value *int16

+ func NewInt16Setting(name string, description string, fallback int16) *Int16Setting

+ func (s *Int16Setting) SetValue(v interface{}) error

+ func (s *Int16Setting) Value() interface{}

+ type Int32Setting struct

+ Int32Value *int32

+ func NewInt32Setting(name string, description string, fallback int32) *Int32Setting

+ func (s *Int32Setting) SetValue(v interface{}) error

+ func (s *Int32Setting) Value() interface{}

+ type Int64Setting struct

+ Int64Value *int64

+ func NewInt64Setting(name string, description string, fallback int64) *Int64Setting

+ func (s *Int64Setting) SetValue(v interface{}) error

+ func (s *Int64Setting) Value() interface{}

+ type Int8Setting struct

+ Int8Value *int8

+ func NewInt8Setting(name string, description string, fallback int8) *Int8Setting

+ func (s *Int8Setting) SetValue(v interface{}) error

+ func (s *Int8Setting) Value() interface{}

+ type IntSetting struct

+ IntValue *int

+ func NewIntSetting(name string, description string, fallback int) *IntSetting

+ func (s *IntSetting) SetValue(v interface{}) error

+ func (s *IntSetting) Value() interface{}

+ type IntSliceSetting struct

+ IntSliceValue *[]int

+ func NewIntSliceSetting(name string, description string, fallback []int) *IntSliceSetting

+ func (s *IntSliceSetting) SetValue(v interface{}) error

+ func (s *IntSliceSetting) Value() interface{}

+ type MapSource struct

+ Map map[string]interface{}

+ func NewEnvSource(env []string) (*MapSource, error)

+ func NewFileSource(path string) (*MapSource, error)

+ func NewJSONSource(b []byte) (*MapSource, error)

+ func NewMapSource(m map[string]interface{}) *MapSource

+ func NewYAMLSource(b []byte) (*MapSource, error)

+ func (s *MapSource) Get(_ context.Context, path ...string) (interface{}, bool)

+ type MultiSource []Source

+ func (ms MultiSource) Get(ctx context.Context, path ...string) (interface{}, bool)

+ type PrefixSource struct

+ Prefix []string

+ Source Source

+ func (s *PrefixSource) Get(ctx context.Context, path ...string) (interface{}, bool)

+ type Setting interface

+ Description func() string

+ Name func() string

+ SetValue func(v interface{}) error

+ Value func() interface{}

+ type SettingGroup struct

+ DescriptionValue string

+ GroupValues []Group

+ NameValue string

+ SettingValues []Setting

+ func (g *SettingGroup) Description() string

+ func (g *SettingGroup) Groups() []Group

+ func (g *SettingGroup) Name() string

+ func (g *SettingGroup) Settings() []Setting

+ type Source interface

+ Get func(ctx context.Context, path ...string) (interface{}, bool)

+ type StringMapStringSetting struct

+ StringMapStringValue *map[string]string

+ func NewStringMapStringSetting(name string, description string, fallback map[string]string) *StringMapStringSetting

+ func (m *StringMapStringSetting) SetValue(v interface{}) error

+ func (m *StringMapStringSetting) Value() interface{}

+ type StringMapStringSliceSetting struct

+ StringMapStringSliceValue *map[string][]string

+ func NewStringMapStringSliceSetting(name string, description string, fallback map[string][]string) *StringMapStringSliceSetting

+ func (m *StringMapStringSliceSetting) SetValue(v interface{}) error

+ func (m *StringMapStringSliceSetting) Value() interface{}

+ type StringSetting struct

+ StringValue *string

+ func NewStringSetting(name string, description string, fallback string) *StringSetting

+ func (s *StringSetting) SetValue(v interface{}) error

+ func (s *StringSetting) Value() interface{}

+ type StringSliceSetting struct

+ StringSliceValue *[]string

+ func NewStringSliceSetting(name string, description string, fallback []string) *StringSliceSetting

+ func (s *StringSliceSetting) SetValue(v interface{}) error

+ func (s *StringSliceSetting) Value() interface{}

+ type TimeSetting struct

+ TimeValue *time.Time

+ func NewTimeSetting(name string, description string, fallback time.Time) *TimeSetting

+ func (s *TimeSetting) SetValue(v interface{}) error

+ func (s *TimeSetting) Value() interface{}

+ type Uint16Setting struct

+ Uint16Value *uint16

+ func NewUint16Setting(name string, description string, fallback uint16) *Uint16Setting

+ func (s *Uint16Setting) SetValue(v interface{}) error

+ func (s *Uint16Setting) Value() interface{}

+ type Uint32Setting struct

+ Uint32Value *uint32

+ func NewUint32Setting(name string, description string, fallback uint32) *Uint32Setting

+ func (s *Uint32Setting) SetValue(v interface{}) error

+ func (s *Uint32Setting) Value() interface{}

+ type Uint64Setting struct

+ Uint64Value *uint64

+ func NewUint64Setting(name string, description string, fallback uint64) *Uint64Setting

+ func (s *Uint64Setting) SetValue(v interface{}) error

+ func (s *Uint64Setting) Value() interface{}

+ type Uint8Setting struct

+ Uint8Value *uint8

+ func NewUint8Setting(name string, description string, fallback uint8) *Uint8Setting

+ func (s *Uint8Setting) SetValue(v interface{}) error

+ func (s *Uint8Setting) Value() interface{}

+ type UintSetting struct

+ UintValue *uint

+ func NewUintSetting(name string, description string, fallback uint) *UintSetting

+ func (s *UintSetting) SetValue(v interface{}) error

+ func (s *UintSetting) Value() interface{}

Other modules containing this package

github.com/asecurityteam/settings