README
¶
go-traits
go-traits is a concept package that helps implement mixin behavior using embedded structs and hook interfaces.
Trait list:
traits.Hasher- An extension for unique hash generators.traits.Converter- An extension for miscellaneous converters.traits.Stringer-fmt.Stringerimplementation extension.traits.Validator- Struct fields validation extension.traits.Default- Struct fields initialization extension.
Marker trait list:
traits.PreventUnkeyed- A struct to embed when you need to forbid unkeyed literals usage.traits.NonComparable- A struct to embed when you need to prevent structs comparison.
Hook interfaces:
traits.bootstrap- theBootstrapfunction will be triggered ontraits.Initcall.traits.schedule- implementtraits.scheduleto schedule a function in a separate goroutine ontraits.Initcall.traits.finalize- theFinalizefunction will be set as an object finalizer viaruntime.SetFinalizerontraits.Initcall.
Examples
type inner struct {
Arr []bool
}
type test struct {
traits.Hasher
traits.Converter
traits.Stringer
traits.Validator
Num int `json:"num"`
Str string `json:"str" valid:"numeric"`
Inn *inner
pstr *string
C chan interface{} `json:"-"`
Iface interface{}
}
func (t *test) Bootstrap() {
fmt.Println("Bootstrap Test struct...")
}
func (t *test) Finalize() {
fmt.Println("Finalize Test struct...")
}
func main() {
str := "bar"
obj := test{
Num: 1,
Str: "abc",
Inn: &inner{make([]bool, 2)},
pstr: &str,
C: make(chan interface{}),
Iface: "foo",
}
traits.Init(&obj)
fmt.Println(obj.String())
fmt.Println(obj.ToJSON())
fmt.Println(obj.Md5Hex())
fmt.Println(obj.Sha256Hex())
fmt.Println(obj.HashCode32())
fmt.Println(obj.Validate())
}
See the examples folder for more.
Contributing
Any proposal or improvement is very welcome.
License
Licensed under the MIT License.
Documentation
¶
Index ¶
- func Init(obj interface{})
- type Converter
- func (conv *Converter) Keys() []string
- func (conv *Converter) ToJSON() (string, error)
- func (conv *Converter) ToJSONIndent(prefix, indent string) (string, error)
- func (conv *Converter) ToMap() map[string]interface{}
- func (conv *Converter) ToXML() (string, error)
- func (conv *Converter) ToXMLIndent(prefix, indent string) (string, error)
- func (conv *Converter) ToYAML() (string, error)
- func (conv *Converter) Values() []interface{}
- type Default
- type Hasher
- type NonComparable
- type PreventUnkeyed
- type Stringer
- type Validator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Converter ¶
type Converter struct {
// contains filtered or unexported fields
}
Converter provides various marshalling methods to an embedding struct.
func (*Converter) ToJSONIndent ¶
ToJSONIndent is like ToJSON but applies Indent to format the output. Each JSON element in the output will begin on a new line beginning with prefix followed by one or more copies of indent according to the indentation nesting.
func (*Converter) ToXMLIndent ¶
ToXMLIndent works like ToXML, but each XML element begins on a new indented line that starts with prefix and is followed by one or more copies of indent according to the nesting depth.
type Default ¶
type Default struct{}
Default adds default initialization to an embedding struct fields. Note that it applies to exported fields only. No public methods exposed for this trait.
type Hasher ¶
type Hasher struct {
// contains filtered or unexported fields
}
Hasher provides unique hash generators to an embedding struct.
func (*Hasher) HashCode32 ¶
HashCode32 generates a unique uint32 hash of an embedding struct.
func (*Hasher) HashCode64 ¶
HashCode64 generates a unique uint64 hash of an embedding struct.
type NonComparable ¶
type NonComparable struct {
// contains filtered or unexported fields
}
NonComparable is a struct to embed when you need to prevent structs comparison.
NonComparable trait doesn't require the `traits.Init` call.
type PreventUnkeyed ¶
type PreventUnkeyed struct {
// contains filtered or unexported fields
}
PreventUnkeyed is a struct to embed when you need to forbid unkeyed literals usage.
PreventUnkeyed trait doesn't require the `traits.Init` call.
type Stringer ¶
type Stringer struct {
// contains filtered or unexported fields
}
Stringer implements the `fmt.Stringer` interface. Adds the String method to an embedding struct.
type Validator ¶
type Validator struct {
// contains filtered or unexported fields
}
Validator adds the Validate function to an embedding struct, which can be used to validate structure fields by tags.
List of available validators for struct fields: "email" "url" "dialstring" "requrl" "requri" "alpha" "utfletter" "alphanum" "utfletternum" "numeric" "utfnumeric" "utfdigit" "hexadecimal" "hexcolor" "rgbcolor" "lowercase" "uppercase" "int" "float" "null" "uuid" "uuidv3" "uuidv4" "uuidv5" "creditcard" "isbn10" "isbn13" "json" "multibyte" "ascii" "printableascii" "fullwidth" "halfwidth" "variablewidth" "base64" "datauri" "ip" "port" "ipv4" "ipv6" "dns" "host" "mac" "latitude" "longitude" "ssn" "semver" "rfc3339" "rfc3339WithoutZone" "ISO3166Alpha2" "ISO3166Alpha3"
Example:
type Example struct {
Str string `valid:"numeric"`
Email string `valid:"email"`
}
Source Files
Directories