result

package

v1.104.2 Latest Latest Go to latest Published: Oct 20, 2026 License: BSD-3-Clause Imports: 0 Imported by: 1

Details

Package result contains the Of result type, which is either a value or an error.

This section is empty.

This section is empty.

This section is empty.

type Of[T any] struct {
	// contains filtered or unexported fields
}

Of is either a T value or an error.

Think of it like Rust or Swift's result types. It's named "Of" because the fully qualified name for callers reads result.Of[T].

func Error[T any](err error) Of[T]

Error returns a new result with error err. If err is nil, the returned result is equivalent to calling Value with T's zero value.

func Value[T any](v T) Of[T]

Value returns a new result with value v, without an error.

func (r Of[T]) Err() error

Err returns r's error, if any. When r.Err returns nil, it's safe to call r.MustValue without it panicking.

func (r Of[T]) MustValue() T

MustValue returns r's result value. It panics if r.Err returns non-nil.

func (r Of[T]) Value() (T, error)

Value returns r's result value and error.