backend

Documentation

Overview

Package backend proides the backends used by fake-gcs-server.

Index

• Constants
• type Bucket
• type BucketAttrs
• type Conditions
• type Error
  • func (e Error) Error() string
• type NoConditions
  • func (NoConditions) ConditionsMet(int64) bool
• type Object
  • func (o Object) StreamingObject() StreamingObject
• type ObjectAttrs
  • func (o *ObjectAttrs) ID() string
  • func (o *ObjectAttrs) IDNoGen() string
• type Storage
  • func NewStorageFS(objects []StreamingObject, rootDir string) (Storage, error)
  • func NewStorageMemory(objects []StreamingObject) (Storage, error)
• type StreamingObject
  • func (o *StreamingObject) BufferedObject() (Object, error)
  • func (o *StreamingObject) Close() error

Constants

const (
	BucketNotFound     = Error("bucket not found")
	BucketNotEmpty     = Error("bucket must be empty prior to deletion")
	PreConditionFailed = Error("Precondition failed")
)

Types

type Bucket

type Bucket struct {
	Name                  string
	VersioningEnabled     bool
	TimeCreated           time.Time
	DefaultEventBasedHold bool
}

Bucket represents the bucket that is stored within the fake server.

type BucketAttrs

type BucketAttrs struct {
	DefaultEventBasedHold bool
	VersioningEnabled     bool
}

type Conditions

type Conditions interface {
	ConditionsMet(activeGeneration int64) bool
}

type Error

type Error string

func (Error) Error

func (e Error) Error() string

type NoConditions

type NoConditions struct{}

func (NoConditions) ConditionsMet

func (NoConditions) ConditionsMet(int64) bool

type Object

type Object struct {
	ObjectAttrs
	Content []byte
}

Object represents the object that is stored within the fake server.

func (Object) StreamingObject

func (o Object) StreamingObject() StreamingObject

type ObjectAttrs

type ObjectAttrs struct {
	BucketName         string `json:"-"`
	Name               string `json:"-"`
	Size               int64  `json:"-"`
	ContentType        string
	ContentEncoding    string
	ContentDisposition string
	CacheControl       string
	Crc32c             string
	Md5Hash            string
	Etag               string
	ACL                []storage.ACLRule
	Metadata           map[string]string
	Created            string
	Deleted            string
	Updated            string
	CustomTime         string
	Generation         int64
}

ObjectAttrs represents the meta-data without its contents.

func (*ObjectAttrs) ID

func (o *ObjectAttrs) ID() string

ID is used for comparing objects.

func (*ObjectAttrs) IDNoGen

func (o *ObjectAttrs) IDNoGen() string

IDNoGen does not consider the generation field.

type Storage

type Storage interface {
	CreateBucket(name string, bucketAttrs BucketAttrs) error
	ListBuckets() ([]Bucket, error)
	GetBucket(name string) (Bucket, error)
	UpdateBucket(name string, attrsToUpdate BucketAttrs) error
	DeleteBucket(name string) error
	CreateObject(obj StreamingObject, conditions Conditions) (StreamingObject, error)
	ListObjects(bucketName string, prefix string, versions bool) ([]ObjectAttrs, error)
	GetObject(bucketName, objectName string) (StreamingObject, error)
	GetObjectWithGeneration(bucketName, objectName string, generation int64) (StreamingObject, error)
	DeleteObject(bucketName, objectName string) error
	PatchObject(bucketName, objectName string, attrsToUpdate ObjectAttrs) (StreamingObject, error)
	UpdateObject(bucketName, objectName string, attrsToUpdate ObjectAttrs) (StreamingObject, error)
	ComposeObject(bucketName string, objectNames []string, destinationName string, metadata map[string]string, contentType string) (StreamingObject, error)
}

Storage is the generic interface for implementing the backend storage of the server.

func NewStorageFS

func NewStorageFS(objects []StreamingObject, rootDir string) (Storage, error)

NewStorageFS creates an instance of the filesystem-backed storage backend.

func NewStorageMemory

func NewStorageMemory(objects []StreamingObject) (Storage, error)

NewStorageMemory creates an instance of StorageMemory.

type StreamingObject

type StreamingObject struct {
	ObjectAttrs
	Content io.ReadSeekCloser
}

func (*StreamingObject) BufferedObject

func (o *StreamingObject) BufferedObject() (Object, error)

Convert this StreamingObject to a (buffered) Object.

func (*StreamingObject) Close

func (o *StreamingObject) Close() error