set

Documentation

Overview

Package set defines the BlockSet interface which provides abstraction for sets of Cids. It provides a default implementation using cid.Set.

Index

• type BlockSet
  • func NewSimpleBlockSet() BlockSet
  • func SimpleSetFromKeys(keys []*cid.Cid) BlockSet

Types

type BlockSet

type BlockSet interface {
	AddBlock(*cid.Cid)
	RemoveBlock(*cid.Cid)
	HasKey(*cid.Cid) bool
	// GetBloomFilter creates and returns a bloom filter to which
	// all the CIDs in the set have been added.
	GetBloomFilter() bloom.Filter
	GetKeys() []*cid.Cid
}

BlockSet represents a mutable set of blocks CIDs.

func NewSimpleBlockSet

func NewSimpleBlockSet() BlockSet

NewSimpleBlockSet returns a new empty default implementation of BlockSet using cid.Set.

func SimpleSetFromKeys

func SimpleSetFromKeys(keys []*cid.Cid) BlockSet

SimpleSetFromKeys returns a default implementation of BlockSet using cid.Set. The given keys are added to the set.