settings

README

Settings

This is a simple example of using generics in Go.

Example

type Setting = settings.Setting[Serialize]

func WithValue(value string) Setting {
	return func(o *Serialize) {
		o.Value = value
	}
}

type Serialize struct {
	Value    string
}

var (
	defaultSerialize = Serialize{
		Value:    "hello",
}

func NewSerialize(ts ...Setting) *Serialize {
	serialize := settings.Apply(&defaultSerialize, ts)
	return serialize
}

func main() {
	serialize = NewSerialize()
	fmt.Println(serialize.Value)
	// Output: hello
	serialize := NewSerialize(WithValue("world"))
	fmt.Println(serialize.Value)
	// Output: world
}

Documentation

Overview

Package settings implements the functions, types, and interfaces for the module.

Index

• func Apply[S any](s *S, fs []func(*S)) *S
• func ApplyAny[S any](s *S, fs []interface{}) *S
• func ApplyOr[S any](s *S, fs ...func(*S)) *S
• func ApplyOrZero[S any](fs ...func(*S)) *S
• type ApplyFunc
  • func (s ApplyFunc[S]) Apply(v *S)
• type ApplySetting
• type Setting

Functions

func Apply

func Apply[S any](s *S, fs []func(*S)) *S

Apply is apply settings

func ApplyAny

func ApplyAny[S any](s *S, fs []interface{}) *S

ApplyAny Applies a set of setting functions to a struct. These Settings functions can be ApplyFunc[S] or func(*S), or objects that implement the ApplySetting interface.

func ApplyOr

func ApplyOr[S any](s *S, fs ...func(*S)) *S

ApplyOr is an apply settings with defaults

func ApplyOrZero

func ApplyOrZero[S any](fs ...func(*S)) *S

ApplyOrZero is an apply settings with defaults

Types

type ApplyFunc

type ApplyFunc[S any] func(*S)

ApplyFunc is a ApplyFunc function for Apply

func (ApplyFunc[S]) Apply

func (s ApplyFunc[S]) Apply(v *S)

type ApplySetting

type ApplySetting[S any] interface {
	Apply(v *S)
}

type Setting

type Setting[S any] interface {
	func(*S) | ApplyFunc[S]
}