result

package

v0.10.0 Latest Latest Go to latest Published: Jan 21, 2024 License: MIT Imports: 3 Imported by: 6

Details

Package result provides a Result type that can contain a value or an error.

This section is empty.

This section is empty.

func Go[T any](f func() (T, error)) chan Result[T]

Go runs a function in a goroutine and returns a channel that will receive the Result.

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

A Result type is a type that can contain an error or a value.

func Err[T any](err error) Result[T]

Err returns a Result that contains an error.

func Errorf[T any](format string, args ...interface{}) Result[T]

Errorf returns a Result that contains a formatted error.

func Ok[T any](value T) Result[T]

Ok returns a Result that contains a value.

func Outcome[T any](value T, err error) Result[T]

Outcome returns a Result that contains a value or an error.

It can be used to convert a function that returns a value and an error into a Result.

func (r Result[T]) Default(value T) T

Default returns the Result value if it is present, otherwise it returns the value passed.

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

Err returns the error, if any.

func (r Result[T]) Get() (T, bool)

Get returns the value and a boolean indicating whether the value is present.

func (r Result[T]) GoString() string

func (r Result[T]) MarshalJSON() ([]byte, error)

func (r Result[T]) String() string

func (r *Result[T]) UnmarshalJSON(data []byte) error