s3ng

Documentation

Index

• func New(ctx context.Context, m map[string]interface{}) (storage.FS, error)
• type Option
• type Options
  • func (o *Options) S3ConfigComplete() bool

Functions

func New

func New(ctx context.Context, m map[string]interface{}) (storage.FS, error)

New returns an implementation to of the storage.FS interface that talk to a local filesystem.

Types

type Option

type Option func(o *Options)

Option defines a single option function.

type Options

type Options struct {

	// Endpoint of the s3 blobstore
	S3Endpoint string `mapstructure:"s3.endpoint"`

	// Region of the s3 blobstore
	S3Region string `mapstructure:"s3.region"`

	// Bucket of the s3 blobstore
	S3Bucket string `mapstructure:"s3.bucket"`

	// Access key for the s3 blobstore
	S3AccessKey string `mapstructure:"s3.access_key"`

	// Secret key for the s3 blobstore
	S3SecretKey string `mapstructure:"s3.secret_key"`
}

Options defines the available options for this package.

func (*Options) S3ConfigComplete

func (o *Options) S3ConfigComplete() bool

S3ConfigComplete return true if all required s3 fields are set.