swarm/storage/mock: add comments to new types and constants

This commit is contained in:
Janos Guljas 2019-02-14 15:42:48 +01:00
parent db914e1421
commit a324f0e9f0

View file

@ -40,8 +40,14 @@ import (
) )
const ( const (
// DefaultLimit should be used as default limit for
// Keys, Nodes, NodeKeys and KeyNodes GlobarStorer
// methids implementations.
DefaultLimit = 100 DefaultLimit = 100
MaxLimit = 1000 // MaxLimit should be used as the maximal returned number
// of items for Keys, Nodes, NodeKeys and KeyNodes GlobarStorer
// methids implementations, regardless of provided limit.
MaxLimit = 1000
) )
// ErrNotFound indicates that the chunk is not found. // ErrNotFound indicates that the chunk is not found.
@ -104,11 +110,13 @@ type GlobalStorer interface {
NewNodeStore(addr common.Address) *NodeStore NewNodeStore(addr common.Address) *NodeStore
} }
// Keys are returned results by Keys and NodeKeys GlobalStorer methods.
type Keys struct { type Keys struct {
Keys [][]byte Keys [][]byte
Next []byte Next []byte
} }
// Nodes are returned results by Nodes and KeyNodes GlobalStorer methods.
type Nodes struct { type Nodes struct {
Addrs []common.Address Addrs []common.Address
Next *common.Address Next *common.Address