go-nul/README.md

86 lines
1.5 KiB
Markdown
Raw Normal View History

2023-09-23 22:53:12 +00:00
# go-nul
Package **nul** implements a **nullable** **optional-type**, for the Go programming language.
2023-11-02 01:19:09 +00:00
In other programming languages, an **optional-type** might be known as: a **option-type**, or a **maybe-type**.
2023-09-23 22:53:12 +00:00
## Documention
Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-nul
2023-09-23 22:53:12 +00:00
[![GoDoc](https://godoc.org/github.com/reiver/go-nul?status.svg)](https://godoc.org/github.com/reiver/go-nul)
2023-09-23 22:53:12 +00:00
## Examples
Here is an example **nullable** **optional-type** that can hold a string:
```go
import "github.com/reiver/go-nul"
2023-09-23 22:53:12 +00:00
//
2023-11-02 15:21:26 +00:00
var op nul.Nullable[string] // the default value is nothing.
2023-09-23 22:53:12 +00:00
// ...
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")
}
```
2023-09-28 10:15:15 +00:00
## Import
To import package **nul** use `import` code like the follownig:
```
import "github.com/reiver/go-nul"
2023-09-28 10:17:37 +00:00
```
2023-09-28 10:15:15 +00:00
2023-09-28 10:18:05 +00:00
## Installation
2023-09-28 10:15:15 +00:00
To install package **nul** do the following:
```
GOPROXY=direct go get https://github.com/reiver/go-nul
2023-09-28 10:15:15 +00:00
```
## Author
2024-08-01 23:32:26 +00:00
Package **nul** was written by [Charles Iliya Krempeaux](http://reiver.link)