option

Documentation

Index

• func OkOr[T any, E error](o Option[T], err E) result.Result[T, E]
• func OkOrElse[T any, E error](o Option[T], err func() E) result.Result[T, E]
• type Option
  • func Map[T, U any](o Option[T], fn func(T) U) Option[U]
  • func None[T any]() Option[T]
  • func Some[T any](value T) Option[T]
  • func Zip[L, R any](l Option[L], r Option[R]) Option[Zipped[L, R]]
  • func (o Option[T]) Expect(a ...any) T
  • func (o Option[T]) Expectf(format string, a ...any) T
  • func (o Option[T]) Filter(pred func(T) bool) Option[T]
  • func (o Option[T]) Format(f fmt.State, verb rune)
  • func (o Option[T]) IsNone() bool
  • func (o Option[T]) IsSome() bool
  • func (o Option[T]) Match(onSome func(T), onNone func())
  • func (o Option[T]) Or(ob Option[T]) Option[T]
  • func (o Option[T]) OrElse(fn func() Option[T]) Option[T]
  • func (o Option[T]) Unwrap() T
  • func (o Option[T]) UnwrapOr(def T) T
  • func (o Option[T]) UnwrapOrElse(fn func() T) T
  • func (o Option[T]) UnwrapOrZero() (value T, ok bool)
  • func (o Option[T]) UnwrapUnchecked() T
• type Zipped

Functions

func OkOr

func OkOr[T any, E error](o Option[T], err E) result.Result[T, E]

func OkOrElse

func OkOrElse[T any, E error](o Option[T], err func() E) result.Result[T, E]

Types

type Option

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

func Map

func Map[T, U any](o Option[T], fn func(T) U) Option[U]

func None

func None[T any]() Option[T]

func Some

func Some[T any](value T) Option[T]

func Zip

func Zip[L, R any](l Option[L], r Option[R]) Option[Zipped[L, R]]

func (Option[T]) Expect

func (o Option[T]) Expect(a ...any) T

func (Option[T]) Expectf

func (o Option[T]) Expectf(format string, a ...any) T

func (Option[T]) Filter

func (o Option[T]) Filter(pred func(T) bool) Option[T]

func (Option[T]) Format

func (o Option[T]) Format(f fmt.State, verb rune)

func (Option[T]) IsNone

func (o Option[T]) IsNone() bool

func (Option[T]) IsSome

func (o Option[T]) IsSome() bool

func (Option[T]) Match

func (o Option[T]) Match(onSome func(T), onNone func())

func (Option[T]) Or

func (o Option[T]) Or(ob Option[T]) Option[T]

func (Option[T]) OrElse

func (o Option[T]) OrElse(fn func() Option[T]) Option[T]

func (Option[T]) Unwrap

func (o Option[T]) Unwrap() T

func (Option[T]) UnwrapOr

func (o Option[T]) UnwrapOr(def T) T

func (Option[T]) UnwrapOrElse

func (o Option[T]) UnwrapOrElse(fn func() T) T

func (Option[T]) UnwrapOrZero

func (o Option[T]) UnwrapOrZero() (value T, ok bool)

UnwrapOrZero is unwrap_or_default but more gopher-ish.

func (Option[T]) UnwrapUnchecked

func (o Option[T]) UnwrapUnchecked() T

UnwrapUnchecked unwraps the Option without checking if it is Some, this may result on unexpected behavior or a panic.

type Zipped

type Zipped[L, R any] struct {
	Left  L
	Right R
}