commit c47b8d7cdb268686255b81f573fe5cc17f64498a Author: Charles Iliya Krempeaux Date: Sun Sep 24 07:53:12 2023 +0900 initial commits diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..87459a0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2017 Charles Iliya Krempeaux :: http://changelog.ca/ + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..42fe3b0 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# 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**. + +## Documention + +Online documentation, which includes examples, can be found at: http://godoc.org/sourcecode.social/reiver/go-nul + +[![GoDoc](https://godoc.org/sourcecode.social/reiver/go-nul?status.svg)](https://godoc.org/sourcecode.social/reiver/go-nul) + +## Examples + +Here is an example **nullable** **optional-type** that can hold a string: +```go +import "sourcecode.social/reiver/go-nul" + +// + +var op nul.Optional[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") +} +```