inital commit

typeutils/result.go

@@ -0,0 +1,92 @@
+package typeutils
+
+// CTORS BEGIN
+func Ok[T any](value T) Result[T] {
+	return Result[T]{value: value, err: nil}
+}
+
+func Err[T any](err error) Result[T] {
+	return Result[T]{err: err}
+}
+
+func Err_t[T any](err error, x T) Result[T] {
+	return Result[T]{err: err}
+}
+
+// CTORS END
+
+func (res Result[T]) Is_ok() bool  { return res.err == nil }
+func (res Result[T]) Is_err() bool { return res.err != nil }
+
+func (res Result[T]) Has_value() bool { return res.Is_ok() }
+
+// UNWRAPPABLE INTERFACE
+func (res Result[T]) Expect(msg string) T {
+	if res.err == nil {
+		return res.value
+	}
+	panic(msg)
+}
+
+func (res Result[T]) Unwrap() T {
+	if res.err == nil {
+		return res.value
+	}
+	panic("Tried unwrapping a Result that had an error a value!")
+}
+
+func (res Result[T]) Unwrap_or(val T) T {
+	if res.err == nil {
+		return res.value
+	}
+	return val
+}
+
+func (res Result[T]) Unwrap_or_default() T {
+	if res.err == nil {
+		return res.value
+	}
+	var ret T
+	return ret
+}
+
+func (res Result[T]) Unwrap_or_else(f func() T) T {
+	if res.err == nil {
+		return res.value
+	}
+	return f()
+}
+
+// UNWRAPPABLE INTERFACE
+
+// This function panic on Ok instead of Err
+func (res Result[T]) Expect_err(msg string) error {
+	if res.err != nil {
+		return res.err
+	}
+	panic(msg)
+}
+
+// This function panic on Ok instead of Err
+func (res Result[T]) Unwrap_err() error {
+	if res.err != nil {
+		return res.err
+	}
+	panic("Expect_err was called with an Ok value")
+}
+
+// transforms Result into Option, mapping Ok(v) to Some(v) and Err(e) to None
+func (res Result[T]) Ok() Optional[T] {
+	if res.err == nil {
+		return Optional[T]{value: res.value, present: true}
+	}
+	return Optional[T]{present: false}
+}
+
+// transforms Result into Option, mapping Err(e) to Some(e) and Ok(v) to None
+func (res Result[T]) Err() Optional[error] {
+	if res.err != nil {
+		return Optional[error]{value: res.err, present: true}
+	}
+	return Optional[error]{present: false}
+}