chezmoiset

Documentation

Overview

Package chezmoiset implements a generic set type.

Index

• type Set
  • func New[T comparable](elements ...T) Set[T]
  • func NewWithCapacity[T comparable](capacity int) Set[T]
  • func (s Set[T]) Add(elements ...T)
  • func (s Set[T]) AddSet(other Set[T])
  • func (s Set[T]) AnyElement() T
  • func (s Set[T]) Contains(element T) bool
  • func (s Set[T]) Elements() []T
  • func (s Set[T]) Empty() bool
  • func (s Set[T]) Remove(elements ...T)

Types

type Set

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

A Set is a set of elements.

func New

func New[T comparable](elements ...T) Set[T]

New returns a new set containing elements.

func NewWithCapacity

func NewWithCapacity[T comparable](capacity int) Set[T]

NewWithCapacity returns a new empty set with the given capacity.

func (Set[T]) Add

func (s Set[T]) Add(elements ...T)

Add adds elements to s.

func (Set[T]) AddSet

func (s Set[T]) AddSet(other Set[T])

AddSet adds all elements from other to s.

func (Set[T]) AnyElement

func (s Set[T]) AnyElement() T

AnyElement returns an arbitrary element from s. It is typically used when s is known to contain exactly one element.

func (Set[T]) Contains

func (s Set[T]) Contains(element T) bool

Contains returns true if s contains element.

func (Set[T]) Elements

func (s Set[T]) Elements() []T

Elements returns all the elements of s.

func (Set[T]) Empty

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

Empty returns if s is empty.

func (Set[T]) Remove

func (s Set[T]) Remove(elements ...T)

Remove removes elements from s.