docstore

Documentation

Index

• Variables
• func ValidKey(key string) error
• type Deleter
• type DocStore
• type Getter
• type Putter

Variables

var (
	// ErrRequestNotFound is returned when a request is not found
	ErrRequestNotFound = fmt.Errorf("key not found")
)

Functions

func ValidKey

func ValidKey(key string) error

ValidKey returns an error if the key is invalid.

Types

type Deleter

type Deleter interface {
	// Put stores the document.
	Delete(ctx context.Context, key string) error
}

Deleter deletes documents.

type DocStore

type DocStore interface {
	Getter
	Putter
	Deleter
}

DocStore provides document services.

type Getter

type Getter interface {
	// Get retrieves the document.
	Get(ctx context.Context, key string) ([]byte, error)
}

Getter gets documents.

type Putter

type Putter interface {
	// Put stores the document.
	Put(ctx context.Context, key string, body []byte) error
}

Putter stores documents.