README
¶
Go-Types
A collection of advanced Golang types and generic wrappers.
Overview
Description
Influenced by JavaScript and Python, the Go-Types package offers Object-Oriented wrappers of Golang types with built-in methods that native types doesn't implement.
They also convert standard library functions into generics methods.
Import
To add this package to your project, use the go get command:
go get github.com/cramanan/go-types
Packages
Boolean
The Boolean type is a wrapper that adds logical operators as methods for booleans. e.g:
The package provides comparison functions for all boolean types.
It also implement a Non-Zero / truthy function.
booleans.False.NOT() // return true
booleans.NOT(isTrue) // returns false
booleans.IsTruthy("") // returns false
String
The String type comes bundled with every functions from the standard strings library as methods. e.g:
import "github.com/cramanan/go-types/strings"
foo := strings.New() // returns "" as strings.String
foo = strings.From("foo") //returns "" foo as strings.String
fmt.Println(foo.ToUpper()) // returns "FOO"
Since gotypes/strings overwrites the standard strings library, the Go-Types package imports, elevates with generics then exports every strings function.
type IString interface { ~string | ~[]byte | ~[]rune }
Every exported functions use the IString interface as a parameter. This allows standard strings manipulation function to work with all the above type.
Slice
The Slice type implements common Array manipulation functions and methods like Filter, Map, Reduce and more. e.g:
bar := slices.New(1, 2, 3) // returns slices.Slice[int]{1, 2, 3}
baz := slices.From([]byte("baz")) // returns Slice[byte]{ 'b', 'a', 'z'}
// Methods
baz = baz.Prepend('f', 'o', 'o') // bar is now Slice[byte]("foobaz")
// Functions
slices.Map(bar, func(i int) int { return i *2 }) // return Slice[int]{2, 4, 6}
The gotypes/slices also overwrites the standard slices library or golang.org/x/exp/slices (depending on your version).
type Ordered Slice[constraints.Ordered]
For simple data types that can be compared, it is better to use the Ordened type. The Slice type is the one used for unordered types. See more
Map
The Map type is a wrapper for map, It adds iteration methods with callback functions. Maps iteration is still in an indeterminate order.
m := New[rune, int]()
m['a'] = 1
m['b'] = 2
m['c'] = 3
callbackFn := func(k rune, v int) bool { return v%2 == 0 }
filtered := m.Filter(callbackFn) // filtered = Map{ 'b' : 2 }
Functions
The functions package provides some callback functions for Funcs arguments. It also provides types from these functions to define arguments, types, methods...
Constants
At that time the constants package doesn't include any useful nor significant value. Feel free to propose any.
Informations
Runtime errors
This package only provides wrappers and do not handle panics. Errors such as out of range, nil pointer dereference or deadlock errors will still panic.
Your code, your rules
For the slices package.
If you wish to use this package and compare custom or complex data types that cannot be compared with comparison operators, you will have to use the Slice type with functions that use your own comparison functions:
- Ordering rules: Defines which of 2 values is greater/lower than the other.
- Equality rule: Defines whether a value is equal to another.
Methods expecting custom rules/functions often have a name ending in "Func". e.g: (slice Slice[T]).ContainsFunc
Author: C. Ramananjaona
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
The booleans package provides Bool type that wraps the built-in Go bool type.
|
The booleans package provides Bool type that wraps the built-in Go bool type. |
|
The functions package provides helper function and function types matching some go-types callback functions.
|
The functions package provides helper function and function types matching some go-types callback functions. |
|
Package maps defines various useful functions with maps of comparable keys and any values.
|
Package maps defines various useful functions with maps of comparable keys and any values. |
|
The slices package provides generic Slice wrapper for the built-in Go slice type and slices functions.
|
The slices package provides generic Slice wrapper for the built-in Go slice type and slices functions. |
|
The strings package provides a String type that wraps the built-in Go string type.
|
The strings package provides a String type that wraps the built-in Go string type. |