Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neocotic/go-optional
Easy-to-use generic optional values for Go (golang)
https://github.com/neocotic/go-optional
Last synced: 22 days ago
JSON representation
Easy-to-use generic optional values for Go (golang)
- Host: GitHub
- URL: https://github.com/neocotic/go-optional
- Owner: neocotic
- License: mit
- Created: 2024-05-03T16:11:43.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-04T08:35:14.000Z (5 months ago)
- Last Synced: 2024-06-19T11:21:39.198Z (5 months ago)
- Language: Go
- Homepage:
- Size: 93.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# go-optional
[](https://pkg.go.dev/github.com/neocotic/go-optional)
[](https://github.com/neocotic/go-optional/actions/workflows/ci.yml)
[](https://github.com/neocotic/go-optional)
[](https://github.com/neocotic/go-optional/blob/main/LICENSE.md)
Easy-to-use generic optional values for Go (golang).
Inspired by Java's `Optional` class, it enables the ability to differentiate a value that has its zero value due to not
being set from having a zero value that was explicitly set, drastically reducing the need for pointers in a lot of use
cases.
## Installation
Install using [go install](https://go.dev/ref/mod#go-install):
``` sh
go install github.com/neocotic/go-optional
```
Then import the package into your own code:
``` go
import "github.com/neocotic/go-optional"
```
## Documentation
Documentation is available on [pkg.go.dev](https://pkg.go.dev/github.com/neocotic/go-optional#section-documentation). It
contains an overview and reference.
### Example
Basic usage:
``` go
opt := optional.Of(0)
opt.IsPresent() // true
opt.Get() // 0, true
opt := optional.Of(123)
opt.IsPresent() // true
opt.Get() // 123, true
var external []int
opt := optional.OfNillable(external)
opt.IsPresent() // false
opt.Get() // nil, false
opt.OrElse([]int{}) // []int{}
opt := optional.Empty[string]()
opt.IsPresent() // false
opt.Get() // "", false
```
Optionals are also intended to be used as struct fields and support JSON, XML, and YAML marshaling and unmarshaling
out-of-the-box. That said; the very nature of optionals leans more towards unmarshaling.
``` go
type Example struct {
Number Optional[int] `json:"number"`
Text Optional[string] `json:"text"`
}
var example Example
err := json.Unmarshal([]byte(`{"text": "abc"}`, &example)
if err != nil {
panic(err)
}
example.Number.Get() // 0, false
example.Text.Get() // "abc", true
```
There's a load of other functions and methods on `Optional` (along with its own `sort` sub-package) to explore, all with
documented examples.
## Issues
If you have any problems or would like to see changes currently in development you can do so
[here](https://github.com/neocotic/go-optional/issues).
## Contributors
If you want to contribute, you're a legend! Information on how you can do so can be found in
[CONTRIBUTING.md](https://github.com/neocotic/go-optional/blob/main/CONTRIBUTING.md). We want your suggestions and pull
requests!
A list of contributors can be found in [AUTHORS.md](https://github.com/neocotic/go-optional/blob/main/AUTHORS.md).
## License
Copyright © 2024 neocotic
See [LICENSE.md](https://github.com/neocotic/go-optional/raw/main/LICENSE.md) for more information on our MIT license.