README
¶
Pkg
pkg is a collection of Go packages that make the life of a Go developers at ZEISS easier.
Installation
go get github.com/katallaxie/pkg
Go has a pretty good standard library, but there are some things that are missing. This collection of small packages is meant to fill those gaps.
Casting values
There is the typical case of pointers you need to deference. For example in the strict interfaces generated by oapi-codegen.
Somestruct {
Field: cast.Ptr(req.Field),
}
Or the other way around, you have a pointer and you want to get the value or a default value.
SomeStruct {
Field: cast.Value(req.Field),
}
Return a default value of a nil pointer.
type Foo struct {}
cast.Zero(Foo) // &Foo{}
Converting values
There is also always the case to covert a value to a specific other value.
// String converts a value to a string.
b := true
s := cast.String(b)
fmt.Println(s) // "true"
There are functions to convert int, string and bool values.
Operators
There is the implementation of various operators.
// Is the ternary operator.
utilx.IfElse(cond, 100, 0)
Databases
There are also more complex tools like the Database interface which enables to easliy implement database wrappers.
// Database provides methods for transactional operations.
type Database[R, W any] interface {
// ReadTx starts a read only transaction.
ReadTx(context.Context, func(context.Context, R) error) error
// ReadWriteTx starts a read write transaction.
ReadWriteTx(context.Context, func(context.Context, W) error) error
Migrator
io.Closer
}
Or a simple interface to implement servers. This takes for all signal and context handling.
s, _ := server.WithContext(ctx)
s.Listen(&srv{}, true)
serverErr := &server.ServerError{}
if err := s.Wait(); errors.As(err, &serverErr) {
log.Print(err)
os.Exit(1)
}
FGA with OpenFGA
There is also a package to work with the OpenFGA API.
// Store is an interface that provides methods for transactional operations on the authz database.
type Store[Tx any] interface {
// Allowed checks if the user is allowed to perform the operation on the object.
Allowed(context.Context, User, Object, Relation) (bool, error)
// WriteTx starts a read write transaction.
WriteTx(context.Context, func(context.Context, Tx) error) error
}
// StoreTx is an interface that provides methods for transactional operations on the authz database.
type StoreTx interface {
// WriteTuple writes a tuple to the authz database.
WriteTuple(context.Context, User, Object, Relation) error
// DeleteTuple deletes a tuple from the authz database.
DeleteTuple(context.Context, User, Object, Relation) error
}
This can be used with the package.
authzStore, err := authx.NewStore(fgaClient, authz.NewWriteTx())
if err != nil {
return err
}
License
Documentation
¶
Overview ¶
Package pkg provides a set of utilities for working with slices in Go.
The package gets extended over time with more utilities. Compatibility should be guaranteed within the last two minor versions.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package async provides a simple way to run functions asynchronously.
|
Package async provides a simple way to run functions asynchronously. |
|
authx
|
|
|
A simple package to cast between types.
|
A simple package to cast between types. |
|
A package channels is a package that contains the channels implementation of the application.
|
A package channels is a package that contains the channels implementation of the application. |
|
cmd
|
|
|
Packag conv provides functions for converting between different types.
|
Packag conv provides functions for converting between different types. |
|
Package enx provides a simple interface to check for the runtime environment.
|
Package enx provides a simple interface to check for the runtime environment. |
|
A package to help with errors.
|
A package to help with errors. |
|
examples
|
|
|
Package filex provides a simple interface to interact with the file system.
|
Package filex provides a simple interface to interact with the file system. |
|
Group package provides a way to manage a group of goroutines.
|
Group package provides a way to manage a group of goroutines. |
|
Package homedir provides a library for detecting the user's home directory without the use of cgo, for use in cross-compilation environments.
|
Package homedir provides a library for detecting the user's home directory without the use of cgo, for use in cross-compilation environments. |
|
Package httpx provides a set of utilities for working with the net/http package.
|
Package httpx provides a set of utilities for working with the net/http package. |
|
Package jsonx provides additional functionality for encoding and decoding JSON.
|
Package jsonx provides additional functionality for encoding and decoding JSON. |
|
reconciler/skip
Package skip allows a Context to carry the intention to skip parts of the code execution.
|
Package skip allows a Context to carry the intention to skip parts of the code execution. |
|
Package mapx provides a set of utilities for working with maps in Go.
|
Package mapx provides a set of utilities for working with maps in Go. |
|
A package server is a package that contains the server implementation of the application.
|
A package server is a package that contains the server implementation of the application. |
|
A package to operate on slices.
|
A package to operate on slices. |
|
Package smtp provides SMTP primitives.
|
Package smtp provides SMTP primitives. |
|
Package stringx provides string manipulation functions.
|
Package stringx provides string manipulation functions. |
|
Package syncx provides some useful synchronization primitives.
|
Package syncx provides some useful synchronization primitives. |
|
Package ulid provides a Universally Unique Lexicographically Sortable Identifier (ULID) implementation in Go.
|
Package ulid provides a Universally Unique Lexicographically Sortable Identifier (ULID) implementation in Go. |
|
Package utilx provides additional utility functions.
|
Package utilx provides additional utility functions. |
Click to show internal directories.
Click to hide internal directories.