https://github.com/reiver/go-nul
Package nul implements a nullable optional-type, for the Go programming language. In other programming languages, an optional-type might be know as: a option-type, or a maybe-type.
https://github.com/reiver/go-nul
maybe-type option-type optional-type
Last synced: 3 months ago
JSON representation
Package nul implements a nullable optional-type, for the Go programming language. In other programming languages, an optional-type might be know as: a option-type, or a maybe-type.
- Host: GitHub
- URL: https://github.com/reiver/go-nul
- Owner: reiver
- License: mit
- Created: 2023-09-28T10:16:43.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-09T03:53:36.000Z (10 months ago)
- Last Synced: 2025-01-25T13:08:08.297Z (4 months ago)
- Topics: maybe-type, option-type, optional-type
- Language: Go
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-nul
Package **nul** implements a **nullable** **optional-type**, for the Go programming language.
In other programming languages, an **optional-type** might be known as: a **option-type**, or a **maybe-type**.
## Documention
Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-nul
[](https://godoc.org/github.com/reiver/go-nul)
## Examples
Here is an example **nullable** **optional-type** that can hold a string:
```go
import "github.com/reiver/go-nul"
//
var op nul.Nullable[string] // the default value is nothing.
// ...
if nul.Nothing[string]() == op {
fmt.Println("nothing")
}
// ...
op = nul.Null[string]()
// ...
if nul.Null[string]() == op {
fmt.Println("null")
}
// ...
op = nul.Something("Hello world! 👾")
// ...
switch op {
case op.Nothing[string]():
//@TODO
case op.Null[string]():
//@TODO
case op.Something("apple"):
//@TODO
case op.Something("banana"):
//@TODO
case op.Something("cherry"):
//@TODO
default:
//@TODO
}
// ...
value, found := op.Get()
if found {
fmt.Println("VALUE:", value)
} else {
fmt.Println("either nothing or null")
}
```
## Import
To import package **nul** use `import` code like the follownig:
```
import "github.com/reiver/go-nul"
```
## Installation
To install package **nul** do the following:
```
GOPROXY=direct go get https://github.com/reiver/go-nul
```
## Author
Package **nul** was written by [Charles Iliya Krempeaux](http://reiver.link)