defaults

package module
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2019 License: MIT Imports: 3 Imported by: 0

README

go-defaults

Actions Status GoDoc GitHub release

(Mostly inspired by github.com/mcuadros/go-defaults)
Enabling stuctures with defaults values using struct tags.

Installation

The recommended way to install go-defaults

go get gopkg.in/xunleii/go-defaults

Examples

A basic example (based on github.com/mcuadros/go-defaults) :

import (
    "fmt"
    "github.com/xunleii/go-defaults"
)

type ExampleBasic struct {
    Foo bool   `default:"true"` //<-- StructTag with a default key
    Bar string `default:"33"`
    Qux int8
    Dur time.Duration `default:"1m"`
}

func NewExampleBasic() *ExampleBasic {
    example := new(ExampleBasic)
    defaults.SetDefaults(example) //<-- This set the defaults values

    return example
}

...

test := NewExampleBasic()
fmt.Println(test.Foo) //Prints: true
fmt.Println(test.Bar) //Prints: 33
fmt.Println(test.Qux) //Prints:
fmt.Println(test.Dur) //Prints: 1m0s

Caveats (also based on github.com/mcuadros/go-defaults)

At the moment, the way the default filler checks whether it should fill a struct field or not is by comparing the current field value with the corresponding zero value of that type. This has a subtle implication: the zero value set explicitly by you will get overriden by default value during SetDefaults() call. So if you need to set the field to container zero value, you need to set it explicitly AFTER setting the defaults.

Take the basic example in the above section and change it slightly:


example := ExampleBasic{
    Bar: 0,
}
defaults.SetDefaults(example)
fmt.Println(example.Bar) //Prints: 33 instead of 0 (which is zero value for int)

example.Bar = 0 // set needed zero value AFTER applying defaults
fmt.Println(example.Bar) //Prints: 0

License

MIT, see LICENSE

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterCustomDefault added in v1.0.1

func RegisterCustomDefault(p reflect.Type, fnc Func)

RegisterCustomDefault bind a custom Func with a specific type allowing to set default value for user defined type.

func SetDefaults

func SetDefaults(v interface{})

SetDefaults applies the default values to the struct object, the struct type must have the StructTag with name "default" and the directed value.

Usage

type ExampleBasic struct {
    Foo bool   `default:"true"`
    Bar string `default:"33"`
    Qux int8
}

 foo := &ExampleBasic{}
 SetDefaults(foo)

Types

type FieldData added in v1.0.1

type FieldData struct {
	Value    reflect.Value
	TagValue string
}

FieldData contains the value and the tag value of a struct field.

type Func added in v1.0.1

type Func func(field *FieldData)

Func is a function that fill any struct field from the tag value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL