https://github.com/serialt/go-defaults
https://github.com/serialt/go-defaults
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/serialt/go-defaults
- Owner: serialt
- License: mit
- Created: 2022-10-30T02:51:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-30T02:51:52.000Z (over 3 years ago)
- Last Synced: 2024-06-21T06:29:59.750Z (almost 2 years ago)
- Language: Go
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
go-defaults [](https://github.com/mcuadros/go-defaults/actions) [](https://pkg.go.dev/github.com/mcuadros/go-defaults) [](https://github.com/mcuadros/go-defaults/releases)
==============================
Enabling stuctures with defaults values using [struct tags](http://golang.org/pkg/reflect/#StructTag).
Installation
------------
The recommended way to install go-defaults
```
go get github.com/mcuadros/go-defaults
```
Examples
--------
A basic example:
```go
import (
"fmt"
"github.com/mcuadros/go-defaults"
"time"
)
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
-------
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:
```go
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](LICENSE)