identifiers.go

package stdmap

import (
	"github.com/onflow/flow-go/model/flow"
	"github.com/onflow/flow-go/module/mempool/model"
)

// Identifiers represents a concurrency-safe memory pool for IDs.
type Identifiers struct {
	*Backend
}

// NewIdentifiers creates a new memory pool for identifiers.
func NewIdentifiers(limit uint) (*Identifiers, error) {
	i := &Identifiers{
		Backend: NewBackend(WithLimit(limit)),
	}
	return i, nil
}

// Add will add the given identifier to the memory pool or it will error if
// the identifier is already in the memory pool.
func (i *Identifiers) Add(id flow.Identifier) bool {
	// wraps ID around an ID entity to be stored in the mempool
	idEntity := &model.IdEntity{
		Id: id,
	}
	return i.Backend.Add(idEntity)
}

// Has checks whether the mempool has the identifier
func (i *Identifiers) Has(id flow.Identifier) bool {
	return i.Backend.Has(id)
}

// Rem removes the given identifier from the memory pool; it will
// return true if the identifier was known and removed.
func (i *Identifiers) Rem(id flow.Identifier) bool {
	return i.Backend.Rem(id)
}

// All returns all identifiers stored in the mempool
func (i *Identifiers) All() flow.IdentifierList {
	entities := i.Backend.All()
	idEntities := make([]flow.Identifier, 0, len(entities))
	for _, entity := range entities {
		idEntity := entity.(*model.IdEntity)
		idEntities = append(idEntities, idEntity.Id)
	}
	return idEntities
}