storage

Documentation

Index

• type Provider
• type Settings
  • func (settings *Settings) Defaults()

Types

type Provider

type Provider interface {
	// NewObject returns the details for object creation.
	NewObject(obj *object.Object) (*object.Object, error)
	// GetObject returns the details of one object.
	GetObject(obj *object.Object) (*object.Object, error)
	// ListObjects returns the details of all objects.
	ListObjects() ([]*object.Object, error)
	// ExistsObject implements object.KeyAvailabilityChecker.
	ExistsObject(obj *object.Object) (bool, error)
	// DeleteObject deletes an object.
	DeleteObject(obj *object.Object) error
	// Settings returns the provider-agnostic storage settings.
	Settings() *Settings
}

Provider defines the contract any storage provider must comply with.

type Settings

type Settings struct {
	// TTL is the time-to-live of objects in storage.
	TTL *time.Duration
}

Settings holds the provider-agnostic storage settings.

func (*Settings) Defaults

func (settings *Settings) Defaults()