comments

Author: RangelReale

options/doc.go

@@ -0,0 +1,2 @@
+// Package options provides an optional standard implementation of [github.com/RangelReale/instruct] options.
+package options

options/option.go

@@ -2,59 +2,76 @@ package options
 
 import "github.com/RangelReale/instruct"
 
+// AnyOption states that the option can be used in any instruct.Decoder function.
 type AnyOption[IT any, DC instruct.DecodeContext] interface {
 	isAnyOption()
 }
 
+// AnyTypeOption states that the option can be used in any instruct.TypeDecoder function.
 type AnyTypeOption[IT any, DC instruct.DecodeContext] interface {
 	isAnyTypeOption()
 }
 
+// DefaultOption states that the option can be used in the instruct.NewDecoder function.
 type DefaultOption[IT any, DC instruct.DecodeContext, DOPTT any] interface {
 	AnyOption[IT, DC]
 	ApplyDefaultOption(*DOPTT)
 }
 
+// TypeDefaultOption states that the option can be used in the instruct.NewTypeDecoder function.
 type TypeDefaultOption[IT any, DC instruct.DecodeContext, TOPTT any] interface {
 	AnyTypeOption[IT, DC]
 	ApplyTypeDefaultOption(*TOPTT)
 }
 
+// DecodeOption states that the option can be used in the [instruct.Decoder.Decode] function.
 type DecodeOption[IT any, DC instruct.DecodeContext, COPTT any] interface {
 	AnyOption[IT, DC]
 	ApplyDecodeOption(*COPTT)
 }
 
+// TypeDecodeOption states that the option can be used in the [instruct.TypeDecoder.Decode] function.
 type TypeDecodeOption[IT any, DC instruct.DecodeContext, COPTT any] interface {
 	AnyTypeOption[IT, DC]
 	ApplyTypeDecodeOption(*COPTT)
 }
 
+// DefaultAndTypeDefaultOption states that the option can be used in the instruct.NewDecoder and
+// instruct.NewTypeDecoder functions.
 type DefaultAndTypeDefaultOption[IT any, DC instruct.DecodeContext, DOPTT any, TOPTT any] interface {
 	DefaultOption[IT, DC, DOPTT]
 	TypeDefaultOption[IT, DC, TOPTT]
 }
 
+// DefaultAndDecodeOption states that the option can be used in the instruct.NewDecoder and
+// [instruct.Decoder.Decode] functions.
 type DefaultAndDecodeOption[IT any, DC instruct.DecodeContext, DOPTT any, COPTT any] interface {
 	DefaultOption[IT, DC, DOPTT]
 	DecodeOption[IT, DC, COPTT]
 }
 
+// TypeDefaultAndTypeDecodeOption states that the option can be used in the instruct.NewTypeDecoder and
+// [instruct.TypeDecoder.Decode] functions.
 type TypeDefaultAndTypeDecodeOption[IT any, DC instruct.DecodeContext, TOPTT any, COPTT any] interface {
 	TypeDefaultOption[IT, DC, TOPTT]
 	TypeDecodeOption[IT, DC, COPTT]
 }
 
+// DefaultAndTypeDefaultDecodeOption states that the option can be used in the [instruct.Decoder.Decode] and
+// [instruct.TypeDecoder.Decode] functions.
 type DefaultAndTypeDefaultDecodeOption[IT any, DC instruct.DecodeContext, DCOPTT any, TCOPTT any] interface {
 	DecodeOption[IT, DC, DCOPTT]
 	TypeDecodeOption[IT, DC, TCOPTT]
 }
 
+// TypeDefaultAndDecodeOption states that the option can be used in the instruct.NewTypeDecoder and
+// [instruct.Decoder.Decode] functions.
 type TypeDefaultAndDecodeOption[IT any, DC instruct.DecodeContext, TOPTT any, DCOPTT any] interface {
 	TypeDefaultOption[IT, DC, TOPTT]
 	DecodeOption[IT, DC, DCOPTT]
 }
 
+// FullOption states that the option can be used in all New functions and Decode methods.
 type FullOption[IT any, DC instruct.DecodeContext, DOPTT any, TOPTT any, DCOPTT any, TCOPTT any] interface {
 	DefaultOption[IT, DC, DOPTT]
 	TypeDefaultOption[IT, DC, TOPTT]

options/option_func.go

@@ -18,6 +18,7 @@ func (f DefaultOptionImpl[IT, DC, DOPTT]) ApplyDefaultOption(o *DOPTT) {
 	f.f(o)
 }
 
+// DefaultOptionFunc is the option constructor for DefaultOption.
 func DefaultOptionFunc[IT any, DC instruct.DecodeContext, DOPTT any](f func(o *DOPTT)) *DefaultOptionImpl[IT, DC, DOPTT] {
 	return &DefaultOptionImpl[IT, DC, DOPTT]{f}
 }
@@ -36,6 +37,7 @@ func (f TypeDefaultOptionImpl[IT, DC, TOPTT]) ApplyTypeDefaultOption(o *TOPTT) {
 	f.tf(o)
 }
 
+// TypeDefaultOptionFunc is the option constructor for TypeDefaultOption.
 func TypeDefaultOptionFunc[IT any, DC instruct.DecodeContext, TOPTT any](tf func(o *TOPTT)) *TypeDefaultOptionImpl[IT, DC, TOPTT] {
 	return &TypeDefaultOptionImpl[IT, DC, TOPTT]{tf}
 }
@@ -54,6 +56,7 @@ func (f DecodeOptionImpl[IT, DC, COPTT]) ApplyDecodeOption(o *COPTT) {
 	f.f(o)
 }
 
+// DecodeOptionFunc is the option constructor for DecodeOption.
 func DecodeOptionFunc[IT any, DC instruct.DecodeContext, COPTT any](f func(o *COPTT)) *DecodeOptionImpl[IT, DC, COPTT] {
 	return &DecodeOptionImpl[IT, DC, COPTT]{f}
 }
@@ -72,6 +75,7 @@ func (f TypeDecodeOptionImpl[IT, DC, COPTT]) ApplyTypeDecodeOption(o *COPTT) {
 	f.f(o)
 }
 
+// TypeDecodeOptionFunc is the option constructor for TypeDecodeOption.
 func TypeDecodeOptionFunc[IT any, DC instruct.DecodeContext, COPTT any](f func(o *COPTT)) *TypeDecodeOptionImpl[IT, DC, COPTT] {
 	return &TypeDecodeOptionImpl[IT, DC, COPTT]{f}
 }
@@ -96,6 +100,7 @@ func (f DefaultAndTypeDefaultOptionImpl[IT, DC, DOPTT, TOPTT]) ApplyTypeDefaultO
 	f.tf(o)
 }
 
+// DefaultAndTypeDefaultOptionFunc is the option constructor for DefaultAndTypeDefaultOption.
 func DefaultAndTypeDefaultOptionFunc[IT any, DC instruct.DecodeContext, DOPTT any, TOPTT any](df func(o *DOPTT), tf func(o *TOPTT)) *DefaultAndTypeDefaultOptionImpl[IT, DC, DOPTT, TOPTT] {
 	return &DefaultAndTypeDefaultOptionImpl[IT, DC, DOPTT, TOPTT]{df, tf}
 }
@@ -119,6 +124,7 @@ func (f DefaultAndDecodeOptionImpl[IT, DC, TOPTT, COPTT]) ApplyDecodeOption(o *C
 	f.cf(o)
 }
 
+// DefaultAndDecodeOptionFunc is the option constructor for DefaultAndDecodeOption.
 func DefaultAndDecodeOptionFunc[IT any, DC instruct.DecodeContext, TOPTT any, COPTT any](tf func(o *TOPTT), cf func(o *COPTT)) *DefaultAndDecodeOptionImpl[IT, DC, TOPTT, COPTT] {
 	return &DefaultAndDecodeOptionImpl[IT, DC, TOPTT, COPTT]{tf, cf}
 }
@@ -142,6 +148,7 @@ func (f TypeDefaultAndTypeDecodeOptionImpl[IT, DC, TOPTT, COPTT]) ApplyTypeDecod
 	f.cf(o)
 }
 
+// TypeDefaultAndTypeDecodeOptionFunc is the option constructor for TypeDefaultAndTypeDecodeOption.
 func TypeDefaultAndTypeDecodeOptionFunc[IT any, DC instruct.DecodeContext, TOPTT any, COPTT any](tf func(o *TOPTT), cf func(o *COPTT)) *TypeDefaultAndTypeDecodeOptionImpl[IT, DC, TOPTT, COPTT] {
 	return &TypeDefaultAndTypeDecodeOptionImpl[IT, DC, TOPTT, COPTT]{tf, cf}
 }
@@ -166,6 +173,7 @@ func (f TypeDefaultAndDecodeOptionImpl[IT, DC, TOPTT, COPTT]) ApplyDecodeOption(
 	f.cf(o)
 }
 
+// TypeDefaultAndDecodeOptionFunc is the option constructor for TypeDefaultAndDecodeOption.
 func TypeDefaultAndDecodeOptionFunc[IT any, DC instruct.DecodeContext, TOPTT any, COPTT any](tf func(o *TOPTT), cf func(o *COPTT)) *TypeDefaultAndDecodeOptionImpl[IT, DC, TOPTT, COPTT] {
 	return &TypeDefaultAndDecodeOptionImpl[IT, DC, TOPTT, COPTT]{tf, cf}
 }
@@ -200,6 +208,7 @@ func (f FullOptionImpl[IT, DC, DOPTT, TOPTT, DCOPTT, TCOPTT]) ApplyTypeDecodeOpt
 	f.tcf(o)
 }
 
+// FullOptionFunc is the option constructor for FullOption.
 func FullOptionFunc[IT any, DC instruct.DecodeContext, DOPTT any, TOPTT any, DCOPTT any, TCOPTT any](df func(o *DOPTT),
 	tf func(o *TOPTT), dcf func(o *DCOPTT), tcf func(o *TCOPTT)) *FullOptionImpl[IT, DC, DOPTT, TOPTT, DCOPTT, TCOPTT] {
 	return &FullOptionImpl[IT, DC, DOPTT, TOPTT, DCOPTT, TCOPTT]{df, tf, dcf, tcf}