transferstore

package

v1.0.2 Latest Latest Go to latest Published: Sep 27, 2018 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nerdalize/nerd

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func TempS3Bucket() (name string, clean func(), err error)
type S3Store
- func NewS3Store(cfg StoreOptions) (store *S3Store, err error)
type StoreOptions
type StoreType

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	//ErrObjectNotExists is returned when a object does not exist
	ErrObjectNotExists = errors.New("object does not exist")
)

Functions ¶

func TempS3Bucket ¶

func TempS3Bucket() (name string, clean func(), err error)

TempS3Bucket creates a temporary s3 bucket that can be removed again by calling clean(). This is mainly usefull for testing purposes throughout the codebase of this project. The name will be a randomly generated name prefixed with 'nerd-tests-'

Types ¶

type S3Store ¶

type S3Store struct {
	// contains filtered or unexported fields
}

S3Store provides an S3 Backed store

func NewS3Store ¶

func NewS3Store(cfg StoreOptions) (store *S3Store, err error)

NewS3Store creates an s3 implementation of the object store

func (*S3Store) Del ¶

func (store *S3Store) Del(ctx context.Context, k string) error

Del will remove an object from the store at key 'k'

func (*S3Store) Get ¶

func (store *S3Store) Get(ctx context.Context, k string, w io.WriterAt) (err error)

Get a object from the store with key 'k' and write it to 'w'

func (*S3Store) Head ¶

func (store *S3Store) Head(ctx context.Context, k string) (size int64, err error)

Head returns metadata for the object

func (*S3Store) Put ¶

func (store *S3Store) Put(ctx context.Context, k string, r io.ReadSeeker) (err error)

Put an object into the store at key 'k' by reading from 'r'

type StoreOptions ¶

type StoreOptions struct {
	Type StoreType `json:"type"`

	S3StoreBucket    string `json:"s3StoreBucket"`
	S3StorePrefix    string `json:"s3StorePrefix"`
	S3StoreAWSRegion string `json:"s3StoreAWSRegion"`
	S3StoreAccessKey string `json:"s3StoreAccessKey"`
	S3StoreSecretKey string `json:"s3StoreSecretKey"`
	S3SessionToken   string `json:"s3SessionToken"`
}

StoreOptions contain options for all stores

type StoreType ¶

type StoreType string

StoreType determines what type the object store will be

const (
	//StoreTypeS3 uses a AWS S3 store
	StoreTypeS3 StoreType = "s3"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL