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.

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 ApplyDefaults[S any](s *S, fs []func(*S)) *S
• func ApplyDefaultsOr[S any](s *S, fs ...func(*S)) *S
• func ApplyDefaultsOrError[S any](s *S, fs ...func(*S)) (*S, error)
• func ApplyDefaultsOrZero[S any](fs ...func(*S)) *S
• func ApplyErrorDefaults[S any](s *S, fs []func(*S)) (*S, error)
• func ApplyErrorDefaultsOr[S any](s *S, fs ...func(*S)) (*S, error)
• func ApplyErrorDefaultsOrZero[S any](fs ...func(*S)) (*S, error)
• 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 Defaulter
• type ErrorDefaulter
• 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 ApplyDefaults

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

ApplyDefaults applies the given settings and default settings to the provided value.

It first applies the given settings using the Apply function, then checks if the value implements the Defaulter interface. If it does, it calls the ApplyDefaults method to apply the default settings.

func ApplyDefaultsOr

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

ApplyDefaultsOr applies the given settings and default settings to the provided value.

It is a convenience wrapper around ApplyDefaults that accepts a variable number of setting functions.

func ApplyDefaultsOrError

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

ApplyDefaultsOrError applies the given settings and default settings to the provided value.

It is a convenience wrapper around ApplyDefaults that accepts a variable number of setting functions.

func ApplyDefaultsOrZero

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

ApplyDefaultsOrZero applies the given settings and default settings to a zero value of the type.

It creates a zero value of the type, then calls ApplyDefaults to apply the given settings and default settings.

func ApplyErrorDefaults

func ApplyErrorDefaults[S any](s *S, fs []func(*S)) (*S, error)

ApplyErrorDefaults applies the given settings and default settings to the provided value.

It first applies the given settings using the Apply function, then checks if the value implements the ErrorDefaulter interface. If it does, it calls the ApplyDefaults method

func ApplyErrorDefaultsOr

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

ApplyErrorDefaultsOr applies the given settings and default settings to the provided value.

It is a convenience wrapper around ApplyDefaults that accepts a variable number of interface{} values.

func ApplyErrorDefaultsOrZero

func ApplyErrorDefaultsOrZero[S any](fs ...func(*S)) (*S, error)

ApplyErrorDefaultsOrZero applies the given settings and default settings to a zero value of the type.

It creates a zero value of the type, then calls ApplyDefaults to apply the given settings and default settings.

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 Defaulter

type Defaulter interface {
	// ApplyDefaults applies the default settings to the implementing type.
	ApplyDefaults()
}

Defaulter is an interface that provides a method to apply default settings.

type ErrorDefaulter

type ErrorDefaulter interface {
	// ApplyDefaults applies the default settings to the implementing type and returns an error.
	ApplyDefaults() error
}

ErrorDefaulter is an interface that provides a method to apply default settings and return an error.

type Setting

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