ucontainer

Documentation

Overview

Package ucontainer extends container and implements generic container types.

Index

• type Memo
  • func NewMemo[T any](update func() T) Memo[T]
  • func (this *Memo[T]) Invalidate()
  • func (this *Memo[T]) Value() T
• type Optional
  • func O[T any](value T) Optional[T]
  • func Void[T any]() Optional[T]
  • func (optional Optional[T]) Exists() bool
  • func (optional Optional[T]) Value() (T, bool)
• type Set
  • func NewSet[T comparable](items ...T) Set[T]
  • func (set Set[T]) Add(item T)
  • func (set Set[T]) Empty() bool
  • func (set Set[T]) Has(item T) bool
  • func (set Set[T]) Pop() (item T)

Types

type Memo

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

Memo holds a cached value.

func NewMemo

func NewMemo[T any](update func() T) Memo[T]

NewMemo creates a new Memo which will take its value from the specified update callback.

func (*Memo[T]) Invalidate

func (this *Memo[T]) Invalidate()

Invalidate marks the Memo's value as invalid, which will cause it to be updated the next time Value is called.

func (*Memo[T]) Value

func (this *Memo[T]) Value() T

Value returns the Memo's value, updating it if the current cached value is invalid.

type Optional

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

Optional can either hold a value, or nothing.

func O

func O[T any](value T) Optional[T]

O creates a new optional with the specified value.

func Void

func Void[T any]() Optional[T]

Void returns an optional with no value.

func (Optional[T]) Exists

func (optional Optional[T]) Exists() bool

Exists returns if the value is currently set.

func (Optional[T]) Value

func (optional Optional[T]) Value() (T, bool)

Value returns the value and true if the value exists. If not, it returns the zero value and false.

type Set

type Set[T comparable] map[T]struct{}

Set is a set of unique items, built on top of map.

func NewSet

func NewSet[T comparable](items ...T) Set[T]

NewSet creates a new set that contains all specified items.

func (Set[T]) Add

func (set Set[T]) Add(item T)

Add adds an item to the set.

func (Set[T]) Empty

func (set Set[T]) Empty() bool

Empty returns true if there are no items in the set.

func (Set[T]) Has

func (set Set[T]) Has(item T) bool

Has returns true if the set contains item.

func (Set[T]) Pop

func (set Set[T]) Pop() (item T)

Pop removes the first accessible item from the set and returns it.