knf

Documentation

Overview

Package knf provides methods for working with configs in KNF format

Index

• func GetB(name string, defvals ...bool) bool
• func GetF(name string, defvals ...float64) float64
• func GetI(name string, defvals ...int) int
• func GetI64(name string, defvals ...int64) int64
• func GetM(name string, defvals ...os.FileMode) os.FileMode
• func GetS(name string, defvals ...string) string
• func GetU(name string, defvals ...uint) uint
• func GetU64(name string, defvals ...uint64) uint64
• func Global(file string) error
• func HasProp(name string) bool
• func HasSection(section string) bool
• func Props(section string) []string
• func Reload() (map[string]bool, error)
• func Sections() []string
• func Validate(validators []*Validator) []error
• type Config
  • func Read(file string) (*Config, error)
  • func (c *Config) GetB(name string, defvals ...bool) bool
  • func (c *Config) GetF(name string, defvals ...float64) float64
  • func (c *Config) GetI(name string, defvals ...int) int
  • func (c *Config) GetI64(name string, defvals ...int64) int64
  • func (c *Config) GetM(name string, defvals ...os.FileMode) os.FileMode
  • func (c *Config) GetS(name string, defvals ...string) string
  • func (c *Config) GetU(name string, defvals ...uint) uint
  • func (c *Config) GetU64(name string, defvals ...uint64) uint64
  • func (c *Config) HasProp(name string) bool
  • func (c *Config) HasSection(section string) bool
  • func (c *Config) Props(section string) []string
  • func (c *Config) Reload() (map[string]bool, error)
  • func (c *Config) Sections() []string
  • func (c *Config) Validate(validators []*Validator) []error
• type PropertyValidator
• type Validator

Examples

• Global
• Reload

Functions

func GetB

func GetB(name string, defvals ...bool) bool

GetB returns global config value as boolean

func GetF

func GetF(name string, defvals ...float64) float64

GetF returns global config value as floating number

func GetI

func GetI(name string, defvals ...int) int

GetI returns global config value as int

func GetI64

func GetI64(name string, defvals ...int64) int64

GetI64 returns global config value as int64

func GetM

func GetM(name string, defvals ...os.FileMode) os.FileMode

GetM returns global config value as file mode

func GetS

func GetS(name string, defvals ...string) string

GetS returns global config value as string

func GetU

func GetU(name string, defvals ...uint) uint

GetU returns global config value as uint

func GetU64

func GetU64(name string, defvals ...uint64) uint64

GetU64 returns global config value as uint64

func Global

func Global(file string) error

Global reads and parses config file Global config will be accessible globally from any part of the code

Example

// Load global config
err := Global("/path/to/your/config.knf")

if err != nil {
	fmt.Printf("Error: %v\n", err)
	return
}

// Read string value
GetS("section:string")

// Read integer value
GetI("section:int")

// Read float value
GetF("section:float")

// Read boolean value
GetB("section:boolean")

// Read file mode value
GetM("section:file-mode")

// Check section
if HasSection("section") {
	// Section exist
}

// Check property
if HasProp("section:string") {
	// Property exist
}

// Slice of all sections
Sections()

// Slice of all properties in section
Props("section")

func HasProp

func HasProp(name string) bool

HasProp check if property exist

func HasSection

func HasSection(section string) bool

HasSection check if section exist

func Props

func Props(section string) []string

Props returns slice with properties names in some section

func Reload

func Reload() (map[string]bool, error)

Reload reads and parse global config file

Example

err := Global("/path/to/your/config.knf")

if err != nil {
	fmt.Printf("Error: %v\n", err)
	return
}

changes, err := Reload()

if err != nil {
	fmt.Printf("Error: %v\n", err)
	return
}

// Print info about changed values
for prop, changed := range changes {
	fmt.Printf("Property %s changed → %t\n", prop, changed)
}

func Sections

func Sections() []string

Sections returns slice with section names

func Validate

func Validate(validators []*Validator) []error

Validate require slice with pointers to validators and returns slice with validation errors

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config is basic config struct

func Read

func Read(file string) (*Config, error)

Read reads and parse config file

func (*Config) GetB

func (c *Config) GetB(name string, defvals ...bool) bool

GetB returns config value as boolean

func (*Config) GetF

func (c *Config) GetF(name string, defvals ...float64) float64

GetF returns config value as floating number

func (*Config) GetI

func (c *Config) GetI(name string, defvals ...int) int

GetI returns config value as int

func (*Config) GetI64

func (c *Config) GetI64(name string, defvals ...int64) int64

GetI64 returns config value as int64

func (*Config) GetM

func (c *Config) GetM(name string, defvals ...os.FileMode) os.FileMode

GetM returns config value as file mode

func (*Config) GetS

func (c *Config) GetS(name string, defvals ...string) string

GetS returns config value as string

func (*Config) GetU

func (c *Config) GetU(name string, defvals ...uint) uint

GetU returns config value as uint

func (*Config) GetU64

func (c *Config) GetU64(name string, defvals ...uint64) uint64

GetU64 returns config value as uint64

func (*Config) HasProp

func (c *Config) HasProp(name string) bool

HasProp check if property exist

func (*Config) HasSection

func (c *Config) HasSection(section string) bool

HasSection check if section exist

func (*Config) Props

func (c *Config) Props(section string) []string

Props returns slice with properties names in some section

func (*Config) Reload

func (c *Config) Reload() (map[string]bool, error)

Reload read and parse config file

func (*Config) Sections

func (c *Config) Sections() []string

Sections returns slice with section names

func (*Config) Validate

func (c *Config) Validate(validators []*Validator) []error

Validate executes all given validators and returns slice with validation errors

type PropertyValidator

type PropertyValidator func(config *Config, prop string, value interface{}) error

PropertyValidator is default type of property validation function

type Validator

type Validator struct {
	Property string            // Property name
	Func     PropertyValidator // Validation function
	Value    interface{}       // Expected value
}

Validator is config property validator struct