store

Documentation

Index

• Variables
• type Store
  • func New(opts ...StoreOption) *Store
  • func (s *Store) Add(p *types.Proposal) error
  • func (s *Store) Get(layer types.LayerID, id types.ProposalID) *types.Proposal
  • func (s *Store) GetBlob(id types.ProposalID) ([]byte, error)
  • func (s *Store) GetForLayer(layer types.LayerID) []*types.Proposal
  • func (s *Store) GetMany(layer types.LayerID, pids ...types.ProposalID) []*types.Proposal
  • func (s *Store) Has(id types.ProposalID) bool
  • func (s *Store) IsEvicted(layer types.LayerID) bool
  • func (s *Store) OnLayer(layer types.LayerID)
• type StoreOption
  • func WithCapacity(capacity uint32) StoreOption
  • func WithEvictedLayer(layer types.LayerID) StoreOption
  • func WithLogger(logger *zap.Logger) StoreOption

Variables

var (
	ErrNotFound       = errors.New("proposal not found")
	ErrLayerEvicted   = errors.New("layer evicted")
	ErrProposalExists = errors.New("proposal already exists")
)

Types

type Store

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

func New

func New(opts ...StoreOption) *Store

func (*Store) Add

func (s *Store) Add(p *types.Proposal) error

func (*Store) Get

func (s *Store) Get(layer types.LayerID, id types.ProposalID) *types.Proposal

func (*Store) GetBlob

func (s *Store) GetBlob(id types.ProposalID) ([]byte, error)

func (*Store) GetForLayer

func (s *Store) GetForLayer(layer types.LayerID) []*types.Proposal

func (*Store) GetMany

func (s *Store) GetMany(layer types.LayerID, pids ...types.ProposalID) []*types.Proposal

func (*Store) Has

func (s *Store) Has(id types.ProposalID) bool

func (*Store) IsEvicted

func (s *Store) IsEvicted(layer types.LayerID) bool

func (*Store) OnLayer

func (s *Store) OnLayer(layer types.LayerID)

type StoreOption

type StoreOption func(*Store)

func WithCapacity

func WithCapacity(capacity uint32) StoreOption

func WithEvictedLayer

func WithEvictedLayer(layer types.LayerID) StoreOption

func WithLogger

func WithLogger(logger *zap.Logger) StoreOption