driver

Documentation

Overview

Package driver includes the interfaces required to implement a blobstore driver.

Index

• Variables
• func Register(name string, o Opener)
• type Driver
• type Iter
• type Iterable
• type Opener
  • func Get(name string) Opener
• type RFile
• type Range
• type Server
• type WFile

Variables

var (
	ErrMetadataNotHandled = errors.New("this driver does not handle metadata")
)

Functions

func Register

func Register(name string, o Opener)

Types

type Driver

type Driver interface {
	Create(id string) (WFile, error)
	Open(id string) (RFile, error)
	Remove(id string) error
	Close() error
}

type Iter

type Iter interface {
	Next(id *string) bool
	Err() error
	Close() error
}

Iter is the same interface as gnd.la/blobstore.Iter. See its documentation.

type Iterable

type Iterable interface {
	Iter() (Iter, error)
}

Iterable is the interface implemented by drivers which can iterate over the files stored in them.

type Opener

type Opener func(url *config.URL) (Driver, error)

func Get

func Get(name string) Opener

type RFile

type RFile interface {
	io.ReadSeeker
	io.Closer
	Metadata() ([]byte, error)
}

type Range

type Range interface {
	IsValid() bool
	Range() (*int64, *int64)
	Set(w http.ResponseWriter, total uint64)
	StatusCode() int
	String() string
}

type Server

type Server interface {
	// Serve serves the file directly from the driver to the given
	// http.ResponseWriter. If this function returns (false, nil)
	// the blobstore will request the file to the driver and serve
	// it by copying its contents to w. Any non nil error return
	// will cause the blobstore to return an error to the caller.
	Serve(w http.ResponseWriter, id string, rng Range) (bool, error)
}

type WFile

type WFile interface {
	io.WriteCloser
	SetMetadata([]byte) error
}