store

type Adapter interface {
	Reader
	Writer

	// Returns arbitrary information about the adapter.
	GetInfo() (interface{}, error)

	// Adds a channel that receives segments whenever they are saved.
	AddDidSaveChannel(chan *cs.Segment)

	// Creates a new Batch
	NewBatch() (Batch, error)
}

type Batch interface {
	Writer

	// Write definitely writes the content of the Batch
	Write() error
}

type BufferedBatch struct {
	ValueOps   []ValueOperation
	SegmentOps []SegmentOperation
	// contains filtered or unexported fields
}

type Filter struct {
	Pagination `json:"pagination"`

	// A map ID the segments must have.
	MapID string `json:"mapId"`

	// A previous link hash the segments must have.
	PrevLinkHash *types.Bytes32 `json:"prevLinkHash"`

	// A slice of tags the segments must all contain.
	Tags []string `json:"tags"`
}

type OpType int

type Pagination struct {
	// Index of the first entry.
	Offset int `json:"offset"`

	// Maximum number of entries, all if zero.
	Limit int `json:"limit"`
}

type Reader interface {
	// Get a segment by link hash. Returns nil if no match is found.
	GetSegment(linkHash *types.Bytes32) (*cs.Segment, error)

	// Find segments. Returns an empty slice if there are no results.
	FindSegments(filter *Filter) (cs.SegmentSlice, error)

	// Get all the existing map IDs.
	GetMapIDs(pagination *Pagination) ([]string, error)

	// Gets a value at a key
	GetValue(key []byte) ([]byte, error)
}

type SegmentOperation struct {
	OpType
	LinkHash *types.Bytes32
	Segment  *cs.Segment
}

type ValueOperation struct {
	OpType
	Key   []byte
	Value []byte
}

type Writer interface {
	// Creates or updates a segment. Segments passed to this method are
	// assumed to be valid.
	SaveSegment(segment *cs.Segment) error

	// Deletes a segment by link hash. Returns the removed segment or nil
	// if not found.
	DeleteSegment(linkHash *types.Bytes32) (*cs.Segment, error)

	// Saves a value at a key.
	SaveValue(key []byte, value []byte) error

	// Deletes a value at a key.
	DeleteValue(key []byte) ([]byte, error)
}