index

Documentation

Index

• type Code
  • func Hash(key string) Code
  • func (c Code) String() string
• type Index
  • func (i *Index) Add(o Indexer, idx int) error
  • func (i *Index) Count() int
  • func (i *Index) Get(o Indexer) (idx int, ok bool)
  • func (i *Index) Has(o Indexer) bool
  • func (i *Index) Remove(o Indexer)
• type Indexer

Types

type Code

type Code uint64

Code is type for result of Hash method to unify logic around

func Hash

func Hash(key string) Code

Hash returns FNV1 hash of string key

func (Code) String

func (c Code) String() string

String return string version (16-base) of hash code

type Index

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

Index is helper type for internal indexes

func (*Index) Add

func (i *Index) Add(o Indexer, idx int) error

Add object's hash to index

func (*Index) Count

func (i *Index) Count() int

Count returns total number of hashed objects in index

func (*Index) Get

func (i *Index) Get(o Indexer) (idx int, ok bool)

Get object's hash and state - same as regular map result

func (*Index) Has

func (i *Index) Has(o Indexer) bool

Has returns true if object's hash was found

func (*Index) Remove

func (i *Index) Remove(o Indexer)

Remove object's hash from index

type Indexer

type Indexer interface {
	Hash() Code
}

Indexer is interface for objects that will be used to build indexes