stringkeyed

Documentation

Index

• type Set
  • func SetOf(elems ...string) (s Set)
  • func (s *Set) Add(elems ...string)
  • func (s Set) All() iter.Seq[string]
  • func (s Set) Cardinality() int
  • func (s Set) MarshalJSON() ([]byte, error)
  • func (s Set) MarshalJSONTo(e *jsontext.Encoder) (err error)
  • func (s Set) ToSlice() []string
  • func (s *Set) UnmarshalJSON(b []byte) error
  • func (s *Set) UnmarshalJSONFrom(d *jsontext.Decoder) error

Types

type Set

type Set struct {
	// contains filtered or unexported fields
}

Set is a set of strings that supports comparison with == and != by foregoing O(1) insertion and membership tests. The zero value is the empty set.

This implementation of Set may handle elements containing the byte values of ASCII control characters less efficiently than elements without such bytes.

func SetOf

func SetOf(elems ...string) (s Set)

SetOf returns a new Set containing the provided elements.

func (*Set) Add

func (s *Set) Add(elems ...string)

Add turns s into the union of s and the provided elements.

In the worst case, the time complexity of Add is O(n log n) in the size of the combined set. Typical implementations of Go can Add a single element in O(n) time.

func (Set) All

func (s Set) All() iter.Seq[string]

All returns an iterator over the sorted elements in s.

func (Set) Cardinality

func (s Set) Cardinality() int

Cardinality returns the number of elements in s in O(n) time. It is more efficient than computing the length of the slice returned by ToSlice.

func (Set) MarshalJSON

func (s Set) MarshalJSON() ([]byte, error)

func (Set) MarshalJSONTo

func (s Set) MarshalJSONTo(e *jsontext.Encoder) (err error)

func (Set) ToSlice

func (s Set) ToSlice() []string

ToSlice returns a sorted slice of the elements in s.

func (*Set) UnmarshalJSON

func (s *Set) UnmarshalJSON(b []byte) error

func (*Set) UnmarshalJSONFrom

func (s *Set) UnmarshalJSONFrom(d *jsontext.Decoder) error