persistence

Documentation

Index

• type Backend
• type BlobData
  • func (d *BlobData) Close() error
  • func (d *BlobData) WriteToFile(path string) error

Types

type Backend

type Backend interface {
	PutBlob(string, *BlobData) error
	GetBlob(string) (*BlobData, error)
}

type BlobData

type BlobData struct {
	// Key is the key for the blob data. This is populated on read and ignored
	// on any other operation.
	Key string

	// Data is the data for the blob data. When writing, this should be
	// the data to write. When reading, this is the data that is read.
	Data io.Reader
	// contains filtered or unexported fields
}

BlobData is the metadata and data associated with stored binary data. The fields and their usage varies depending on the operations, so please read the documentation for each field carefully.

func (*BlobData) Close

func (d *BlobData) Close() error

func (*BlobData) WriteToFile

func (d *BlobData) WriteToFile(path string) error

WriteToFile is a helper to write BlobData to a file. While this is a very easy thing to do, it is so common that we provide a function for doing so.