creational

Documentation

Index

• func Construct[O Object, FO Option[O] | optionAlias[O]](obj O, opts ...FO) (O, error)
• func ConstructWithContext[O Object, FO OptionWithContext[O] | optionWithContextAlias[O]](ctx context.Context, obj O, opts ...FO) (O, error)
• func ConstructWithContextValidate[O ObjectValidable, FO OptionWithContext[O] | optionWithContextAlias[O]](ctx context.Context, obj O, opts ...FO) (O, error)
• func ConstructWithValidate[O ObjectValidable, FO Option[O] | optionAlias[O]](obj O, opts ...FO) (O, error)
• func Must[T any](t T, err error) T
• func MustNew[O Object, FO Option[O] | optionAlias[O]](opts ...FO) O
• func New[O Object, FO Option[O] | optionAlias[O]](opts ...FO) (O, error)
• func NewWithContext[O Object, FO OptionWithContext[O] | optionWithContextAlias[O]](ctx context.Context, opts ...FO) (O, error)
• func NewWithContextValidate[O ObjectValidable, FO OptionWithContext[O] | optionWithContextAlias[O]](ctx context.Context, opts ...FO) (O, error)
• func NewWithValidate[O ObjectValidable, FO Option[O] | optionAlias[O]](opts ...FO) (O, error)
• type Object
• type ObjectValidable
• type Option
• type OptionWithContext

Examples

• New
• NewWithContext
• NewWithContextValidate
• NewWithValidate

Functions

func Construct

func Construct[
	O Object,
	FO Option[O] | optionAlias[O],
](
	obj O,
	opts ...FO,
) (O, error)

func ConstructWithContext

func ConstructWithContext[
	O Object,
	FO OptionWithContext[O] | optionWithContextAlias[O],
](
	ctx context.Context,
	obj O,
	opts ...FO,
) (O, error)

func ConstructWithContextValidate

func ConstructWithContextValidate[
	O ObjectValidable,
	FO OptionWithContext[O] | optionWithContextAlias[O],
](
	ctx context.Context,
	obj O,
	opts ...FO,
) (O, error)

func ConstructWithValidate

func ConstructWithValidate[
	O ObjectValidable,
	FO Option[O] | optionAlias[O],
](
	obj O,
	opts ...FO,
) (O, error)

func Must

func Must[T any](t T, err error) T

func MustNew

func MustNew[
	O Object,
	FO Option[O] | optionAlias[O],
](
	opts ...FO,
) O

func New

func New[
	O Object,
	FO Option[O] | optionAlias[O],
](
	opts ...FO,
) (O, error)

Example

ExampleNew just configures object - no validate applied

opts := []WorkerOption{
	WithW(invalidW), nil,
	WithS(invalidS), nil,
	WithI(invalidI), nil,
}

obj, err := New(opts...)
if err != nil {
	panic(err)
}

fmt.Printf("%s\n", obj)

Output:

s=lolkek;i=999;w_is_nil=true;is_valid=false;

func NewWithContext

func NewWithContext[
	O Object,
	FO OptionWithContext[O] | optionWithContextAlias[O],
](
	ctx context.Context,
	opts ...FO,
) (O, error)

Example

ExampleNewWithContext just configures object - no validate applied. Also ctx is required For example - http.Request as struct attribute

ctx := context.TODO()

opts := []WorkerOptionWithContext{
	WithWCtx(invalidW), nil,
	WithSCtx(invalidS), nil,
	WithICtx(invalidI), nil,
}

obj, err := NewWithContext(ctx, opts...)
if err != nil {
	panic(err)
}

fmt.Printf("%s\n", obj)

Output:

s=lolkek;i=999;w_is_nil=true;is_valid=false;

func NewWithContextValidate

func NewWithContextValidate[
	O ObjectValidable,
	FO OptionWithContext[O] | optionWithContextAlias[O],
](
	ctx context.Context,
	opts ...FO,
) (O, error)

Example

ExampleNewWithContextValidate configures and validates object. Also ctx is required For example - http.Request as struct attribute

ctx := context.TODO()

opts := []WorkerOptionWithContext{
	WithWCtx(validW), nil,
	WithSCtx(validS), nil,
	WithICtx(validI), nil,
}

obj, err := NewWithContextValidate(ctx, opts...)
if err != nil {
	panic(err)
}

fmt.Printf("%s\n", obj)

Output:

s=foobar;i=100500;w_is_nil=false;is_valid=true;

func NewWithValidate

func NewWithValidate[
	O ObjectValidable,
	FO Option[O] | optionAlias[O],
](
	opts ...FO,
) (O, error)

Example

ExampleNewWithValidate configures and validates object

opts := []WorkerOption{
	WithW(validW), nil,
	WithS(validS), nil,
	WithI(validI), nil,
}

obj, err := NewWithValidate(opts...)
if err != nil {
	panic(err)
}

fmt.Printf("%s\n", obj)

Output:

s=foobar;i=100500;w_is_nil=false;is_valid=true;

Types

type Object

type Object interface{ any }

type ObjectValidable

type ObjectValidable interface{ Validate() error }

type Option

type Option[O Object] func(*O) error

type OptionWithContext

type OptionWithContext[O Object] func(context.Context, *O) error