capacityset

README

capacityset

Capacityset provides a set with a maximum size.

Summary

Capacityset implements a set (unordered, non-repeating) that cannot exceed a provisioned size.

Install

This repo is a package. There is no installation.

Contributing

Refer to CONTRIBUTING.md.

Documentation

Index

• func SendToChannel(f func() interface{}) <-chan interface{}
• type Set
  • func NewCapacitySet(capacity int) Set

Functions

func SendToChannel

func SendToChannel(f func() interface{}) <-chan interface{}

Types

type Set

type Set interface {
	// Adds an element to the set. Returns whether
	// the item was added.
	Add(item interface{}) bool

	// Pop returns an item from the set
	Pop() interface{}

	// Size returns the number of items in the set
	Size() int
}

Set is the interface of the common set storage pattern

func NewCapacitySet

func NewCapacitySet(capacity int) Set

NewCapacitySet returns the set interface with max capacity allowing of a set with cap