safetypes

Rust like result and option implementation for golang

Examples

import "github.com/JPratama7/safe"

Option

import "github.com/JPratama7/safe"

func checkUnwrap(opt safe.Option[int]) {
    if opt.IsSome() {
        println(opt.Unwrap())
    } else {
        panic("poor option :(")
    }
}

import "github.com/JPratama7/safe"

func checkUnwrapOr(opt safe.Option[int]) {
    println(opt.UnwrapOr(10))
}

import "github.com/JPratama7/safe"

func retrunOption(some bool) (opt safe.Option[int]) {
    if some {
        return opt.Some(7)
    }
    return opt.None()
}

import "github.com/JPratama7/safe"

type Test struct {
    Field safe.Option[int]
}

func jsonMarshal(t Test) {
    res := safe.AsResult(json.Marshal(s))
    if res.IsOk() {
        // if some: "Test{Field: 7}"
        // if none: "Test{Field: {}}"
        println(res.Unwrap())
    } else {
        panic(res.Error())
    }
}

Result

func checkUnwrap(res safe.Result[int]) {
    if res.IsOk() {
        println(res.Unwrap())
    } else {
        panic(res.Error())
    }
}

import "github.com/JPratama7/safe"

func retrunResult(some bool) (res safe.Result[int]) {
    if some {
        return res.Ok(7)
    }
    return res.Err("some fancy error msg")
}

Benchmark

go test -bench=.
goos: linux
goarch: amd64
pkg: github.com/JPratama7/safe
cpu: AMD Ryzen 5 3500U with Radeon Vega Mobile Gfx  
BenchmarkOkSlicesStruct-8               1000000000               0.4642 ns/op          0 B/op          0 allocs/op
BenchmarkOkSlicesString-8               1000000000               0.4443 ns/op          0 B/op          0 allocs/op
BenchmarkOkSlicesInt-8                  1000000000               0.4812 ns/op          0 B/op          0 allocs/op
BenchmarkOkMapIntString-8               1000000000               0.4609 ns/op          0 B/op          0 allocs/op
BenchmarkResult_Err-8                   1000000000               0.4570 ns/op          0 B/op          0 allocs/op
BenchmarkResult_Ok-8                    1000000000               0.4541 ns/op          0 B/op          0 allocs/op
BenchmarkResultTestOk-8                 1000000000               0.4341 ns/op          0 B/op          0 allocs/op
BenchmarkAsResultEmptyErr-8             1000000000               0.4380 ns/op          0 B/op          0 allocs/op
BenchmarkAsResultEmptyNoErr-8           1000000000               0.4588 ns/op          0 B/op          0 allocs/op
BenchmarkResult_OkInt-8                 1000000000               0.4546 ns/op          0 B/op          0 allocs/op
BenchmarkResult_EmptyInt-8              1000000000               0.4531 ns/op          0 B/op          0 allocs/op
BenchmarkResult_OkString-8              1000000000               0.4597 ns/op          0 B/op          0 allocs/op
BenchmarkResult_EmptyString-8           1000000000               0.4449 ns/op          0 B/op          0 allocs/op
BenchmarkOption_Some-8                  1000000000               0.4482 ns/op          0 B/op          0 allocs/op
BenchmarkOption_None-8                  1000000000               0.4482 ns/op          0 B/op          0 allocs/op
BenchmarkOption_IsNone-8                1000000000               0.4710 ns/op          0 B/op          0 allocs/op
BenchmarkOption_IsSome-8                1000000000               0.4466 ns/op          0 B/op          0 allocs/op
BenchmarkErrorCheck-8                   1000000000               0.4711 ns/op          0 B/op          0 allocs/op
PASS
ok      github.com/JPratama7/safe       9.108s

Note

Error and None methods usable as structless but it doesn't infere types so instead of using safetypes.None[T]() and safetypes.Err[T]("") you could use them as how in examples above