list

Documentation

Index

• type Element
• type FilterFunc
• type List
  • func New() *List
  • func (l *List) All(fn FilterFunc, opts ...Option) *List
  • func (l *List) Discard(fn FilterFunc, opts ...Option) int
  • func (l *List) DiscardFirst(fn FilterFunc, opts ...Option) bool
  • func (l *List) Each(fn FilterFunc, opts ...Option)
  • func (l *List) First(fn FilterFunc, opts ...Option) *list.Element
  • func (l *List) String() string
• type Option
• type Options
  • func (opts Options) Backward() bool

Types

type Element

type Element = list.Element

type FilterFunc

type FilterFunc func(e *Element) bool

FilterFunc is a user provided function to filter elements on a list.

type List

type List struct {
	*list.List
}

List is an augmentation of a container/list that provides convenience functions.

func New

func New() *List

New returns a new List

func (*List) All

func (l *List) All(fn FilterFunc, opts ...Option) *List

All returns a new list containing all the matching elements given the FilterFunc fn.

func (*List) Discard

func (l *List) Discard(fn FilterFunc, opts ...Option) int

Discard removes all items matching the FilterFunc from the list.

func (*List) DiscardFirst

func (l *List) DiscardFirst(fn FilterFunc, opts ...Option) bool

Discard removes the first item matching the FilterFunc from the list.

func (*List) Each

func (l *List) Each(fn FilterFunc, opts ...Option)

Each iterate over a List executing fn on every item. Each will stop the iteration if fn returns false.

func (*List) First

func (l *List) First(fn FilterFunc, opts ...Option) *list.Element

First returns the first element in the list matching FilterFunc.

func (*List) String

func (l *List) String() string

String returns the string representation of the List It calls .String() on items if defined.

type Option

type Option int

const (
	Backward Option = 1 << iota
)

type Options

type Options []Option

func (Options) Backward

func (opts Options) Backward() bool