result

Documentation

Index

• type Result
  • func Err[T any](err error) Result[T]
  • func Ok[T any](value T) Result[T]
  • func Wrap[T any](value T, err error) Result[T]
  • func (r Result[T]) Assert(noErrFn func(err error, msgAndArgs ...interface{})) T
  • func (r Result[T]) MarshalJSON() ([]byte, error)
  • func (r Result[T]) Unwrap() (T, error)

Types

type Result

type Result[T any] struct {
	Value T
	Error error
}

Result is a small wrapper type encapsulating Value/Error tuples, mostly for use when sending values across channels NOTE: Avoid adding any functionality to this, any "nice" things added here will make it more difficult to switch to a more standardised Result-like type when one gets into the stdlib, or when we will want to switch to a library providing those types.

func Err

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

func Ok

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

func Wrap

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

func (Result[T]) Assert

func (r Result[T]) Assert(noErrFn func(err error, msgAndArgs ...interface{})) T

func (Result[T]) MarshalJSON

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

MarshalJSON implements the json.Marshaler interface, marshalling string error correctly this method makes the display in log.Infow nicer

func (Result[T]) Unwrap

func (r Result[T]) Unwrap() (T, error)