README
¶
DL(Default Loader)
Overview
DL (Default Loader) is a tool designed to generate and assign default values to fields within Go structs based on tags.
This utility allows you to specify default values for your struct fields using a simple tag syntax, making it easier to
initialize structs with predefined values without having to explicitly set them in your code.
defaults.go is forked from creasty/defaults
Features
- Tag-based Default Values: Use the
defaulttag to set default values for struct fields. - Easy Integration: Quickly generate methods to load default values into your structs.
- Efficient Initialization: Simplifies the initialization process of complex structs by automatically setting default values.
Installation
To use DL (Default Loader), first install the tool via:
go install github.com/godcong/dl/cmd@latest
Usage
Step 1: Define Struct with Default Tags
Add the default tag to your struct fields to specify their default values:
// example: demo.go
type Demo struct {
Name string `default:"demo"`
}
Step 2: Generate Default Value Loading Method
Run DL to generate the necessary loading method for your struct:
dl -f ./demo.go
Step 3: Load Default Values
In your code, use dl.Load() to populate your struct with the default values:
func main() {
demo := &Demo{}
if err := dl.Load(demo); err != nil {
panic(err)
}
// Now 'demo' has its fields initialized with default values.
}
Documentation
¶
Overview ¶
Package dl for Default Loader
Package dl for Default Loader ¶
Package dl for Default Loader
Index ¶
- Variables
- func CanUpdate(v interface{}) bool
- func InvalidTypeError(typeString string) error
- func Load[T any](ptr *T) error
- func LoadInterface[P any](ptr any, arg P) (bool, error)
- func LoadStruct(ptr any) error
- func LoadWithOption[T any, P any](ptr *T, arg P) error
- func MustLoad[T any](ptr *T)
- func Pointer[T any](v T) *T
- type DefaultLoader
- type DefaultLoaderFunc
- type DefaultOptionLoader
- type DefaultOptionLoaderFunc
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidType = errors.New("empty")
Functions ¶
func CanUpdate ¶ added in v0.0.7
func CanUpdate(v interface{}) bool
CanUpdate returns true when the given value is an initial value of its type
func InvalidTypeError ¶
func Load ¶
Load initializes members in a struct referenced by a pointer. Maps and slices are initialized by `make` and other primitive types are set with default values. `ptr` should be a struct pointer
func LoadInterface ¶
LoadInterface initializes members in a struct referenced by a pointer. Maps and slices are initialized by `make` and other primitive types are set with default values. `ptr` should be a struct pointer
func LoadStruct ¶
LoadStruct initializes members in a struct referenced by a pointer. Maps and slices are initialized by `make` and other primitive types are set with default values. `ptr` should be a struct pointer
func LoadWithOption ¶ added in v0.0.7
LoadWithOption initializes members in a struct referenced by a pointer. Maps and slices are initialized by `make` and other primitive types are set with default values. `ptr` should be a struct pointer
Types ¶
type DefaultLoader ¶
type DefaultLoader interface {
Default() error
}
DefaultLoader is an interface that can be implemented by structs to customize the default
type DefaultLoaderFunc ¶ added in v0.0.7
DefaultLoaderFunc is a function type that defines a function to load default values into a struct referenced by a pointer.
type DefaultOptionLoader ¶ added in v0.0.7
DefaultOptionLoader is an interface that specifies a method to load default values into a struct with a parameter.
type DefaultOptionLoaderFunc ¶ added in v0.0.7
DefaultOptionLoaderFunc is a function type that defines a function to load default values into a struct with a parameter.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package main
|
Package main |
|
Package gen for Default Loader
|
Package gen for Default Loader |
|
internal
|
|
|
io
Package io for Default Loader
|
Package io for Default Loader |
|
shell
Package shell for Default Loader
|
Package shell for Default Loader |
|
tpl
Package tpl for Default Loader
|
Package tpl for Default Loader |