go-opt/README.md

# go-opt

Package **opt** implements an **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**.

## Documention

Online documentation, which includes examples, can be found at: http://godoc.org/sourcecode.social/reiver/go-opt

[![GoDoc](https://godoc.org/sourcecode.social/reiver/go-opt?status.svg)](https://godoc.org/sourcecode.social/reiver/go-opt)

## Examples

Here is an example **optional-type** that can hold a string:
```go
import "sourcecode.social/reiver/go-opt"

//

var op opt.Optional[string] // the default value is nothing.

// ...

if opt.Nothing[string]() == op {
	fmt.Println("nothing")
}

// ...

op = opt.Something("Hello world! 👾")

// ...

switch op {
case op.Nothing[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("nothing")
}
```

## Import

To import package **opt** use `import` code like the follownig:
```
import "sourcecode.social/reiver/go-opt"
```

## Installation

To install package **opt** do the following:
```
GOPROXY=direct go get https://sourcecode.social/reiver/go-opt
```

## Author

Package **opt** was written by [Charles Iliya Krempeaux](http://reiver.link)