store

type Deleter ¶

type Deleter interface {
	Delete(i Item) error
}

Deleter is the interface that wraps the basic Delete method.

Delete deletes i from the underlying datastore. It returns any error encountered that prevented the deletion from occurring.

type Item ¶

type Item interface {
	Key() string
	SetKey(string)
}

Item is the interface that wraps Key and SetKey methods.

Key returns a unique idenfier for the item from the implementation. It is called by the implementing store when retrieving objects from its underlying store.

SetKey sets the item key. It is called by the store when Unmarshalling objects from its underlying store.

The below example illustrates usage:

type Hacker struct {
	Id        string
	Name      string
	Birthyear int
}

func (h *Hacker) Key() string {
	return h.Id
}

func (h *Hacker) SetKey(k string) {
	h.Id = k
}

type Lister ¶

type Lister interface {
	List(interface{}) error
}

Lister is the interface that wraps the basic List method.

type MultiDeleter ¶

type MultiDeleter interface {
	DeleteMultiple(items []Item) (int, error)
}

MultiDeleter is the interface that wraps DeleteMultiple method.

type MultiReadWriter ¶

type MultiReadWriter interface {
	MultiReader
	MultiWriter
	MultiDeleter
}

MultiReadWriter is the interface that groups MultiReader and MultiWriter interfaces.

type MultiReader ¶

type MultiReader interface {
	ReadMultiple(interface{}) error
}

MultiReader is the interface that wraps ReadMultiple method.

type MultiWriter ¶

type MultiWriter interface {
	WriteMultiple(items []Item) error
}

MultiWriter is the interface that wraps WriteMultiple method.

type ReadWriter ¶

type ReadWriter interface {
	Reader
	Writer
	Deleter
}

ReadWriter is the interface that groups Reader, Writer and Deleter interfaces.

type Reader ¶

type Reader interface {
	Read(i Item) error
}

Reader is the interface that wraps the basic Read method.

Read reads i from the underlying data store and copies to i. It returns any error encountered that caused the write to stop early.

type Store ¶

type Store interface {
	ReadWriter
	Lister
	MultiReadWriter
}

Store is the interface to store implemented in package redis. It groups ReadWriter, Lister and MultiReader interfaces.

type Writer ¶

type Writer interface {
	Write(i Item) error
}

Writer is the interface that wraps the basic Write method.

Write writes i to the underlying data store. It expects i.Key method to return a unique identifier for the item, it will otherwise generate a unique identifier and calls i.SetKey method. It returns any error encountered that caused the write to stop early.