s3

Documentation

Overview

Package s3 provided support for AWS s3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/Welcome.html)

Code generated by go generate via internal/cmd/service; DO NOT EDIT.

Index

• Constants
• func New(pairs ...*types.Pair) (storage.Servicer, storage.Storager, error)
• type Service
  • func (s *Service) Create(name string, pairs ...*types.Pair) (storage.Storager, error)
  • func (s *Service) CreateWithContext(ctx context.Context, name string, pairs ...*types.Pair) (storage.Storager, error)
  • func (s *Service) Delete(name string, pairs ...*types.Pair) (err error)
  • func (s *Service) DeleteWithContext(ctx context.Context, name string, pairs ...*types.Pair) (err error)
  • func (s *Service) Get(name string, pairs ...*types.Pair) (storage.Storager, error)
  • func (s *Service) GetWithContext(ctx context.Context, name string, pairs ...*types.Pair) (storage.Storager, error)
  • func (s *Service) List(pairs ...*types.Pair) (err error)
  • func (s *Service) ListWithContext(ctx context.Context, pairs ...*types.Pair) (err error)
  • func (s *Service) String() string
• type Storage
  • func (s *Storage) Delete(path string, pairs ...*types.Pair) (err error)
  • func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...*types.Pair) (err error)
  • func (s *Storage) List(path string, pairs ...*types.Pair) (err error)
  • func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...*types.Pair) (err error)
  • func (s *Storage) Metadata(pairs ...*types.Pair) (m metadata.StorageMeta, err error)
  • func (s *Storage) MetadataWithContext(ctx context.Context, pairs ...*types.Pair) (m metadata.StorageMeta, err error)
  • func (s *Storage) Read(path string, pairs ...*types.Pair) (r io.ReadCloser, err error)
  • func (s *Storage) ReadWithContext(ctx context.Context, path string, pairs ...*types.Pair) (r io.ReadCloser, err error)
  • func (s *Storage) Stat(path string, pairs ...*types.Pair) (o *types.Object, err error)
  • func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...*types.Pair) (o *types.Object, err error)
  • func (s *Storage) String() string
  • func (s *Storage) Write(path string, r io.Reader, pairs ...*types.Pair) (err error)
  • func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, pairs ...*types.Pair) (err error)

Constants

const Type = "s3"

Type is the type for s3

Functions

func New

func New(pairs ...*types.Pair) (storage.Servicer, storage.Storager, error)

New will create a new s3 service.

Types

type Service

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

Service is the s3 service config.

func (*Service) Create

func (s *Service) Create(name string, pairs ...*types.Pair) (storage.Storager, error)

Create implements Servicer.Create

func (*Service) CreateWithContext

func (s *Service) CreateWithContext(ctx context.Context, name string, pairs ...*types.Pair) (storage.Storager, error)

CreateWithContext adds context support for Create.

func (*Service) Delete

func (s *Service) Delete(name string, pairs ...*types.Pair) (err error)

Delete implements Servicer.Delete

func (*Service) DeleteWithContext

func (s *Service) DeleteWithContext(ctx context.Context, name string, pairs ...*types.Pair) (err error)

DeleteWithContext adds context support for Delete.

func (*Service) Get

func (s *Service) Get(name string, pairs ...*types.Pair) (storage.Storager, error)

Get implements Servicer.Get

func (*Service) GetWithContext

func (s *Service) GetWithContext(ctx context.Context, name string, pairs ...*types.Pair) (storage.Storager, error)

GetWithContext adds context support for Get.

func (*Service) List

func (s *Service) List(pairs ...*types.Pair) (err error)

List implements Servicer.List

func (*Service) ListWithContext

func (s *Service) ListWithContext(ctx context.Context, pairs ...*types.Pair) (err error)

ListWithContext adds context support for List.

func (*Service) String

func (s *Service) String() string

String implements Servicer.String

type Storage

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

Storage is the s3 object storage service.

func (*Storage) Delete

func (s *Storage) Delete(path string, pairs ...*types.Pair) (err error)

Delete implements Storager.Delete

func (*Storage) DeleteWithContext

func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...*types.Pair) (err error)

DeleteWithContext adds context support for Delete.

func (*Storage) List

func (s *Storage) List(path string, pairs ...*types.Pair) (err error)

List implements Storager.List

func (*Storage) ListWithContext

func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...*types.Pair) (err error)

ListWithContext adds context support for List.

func (*Storage) Metadata

func (s *Storage) Metadata(pairs ...*types.Pair) (m metadata.StorageMeta, err error)

Metadata implements Storager.Metadata

func (*Storage) MetadataWithContext

func (s *Storage) MetadataWithContext(ctx context.Context, pairs ...*types.Pair) (m metadata.StorageMeta, err error)

MetadataWithContext adds context support for Metadata.

func (*Storage) Read

func (s *Storage) Read(path string, pairs ...*types.Pair) (r io.ReadCloser, err error)

Read implements Storager.Read

func (*Storage) ReadWithContext

func (s *Storage) ReadWithContext(ctx context.Context, path string, pairs ...*types.Pair) (r io.ReadCloser, err error)

ReadWithContext adds context support for Read.

func (*Storage) Stat

func (s *Storage) Stat(path string, pairs ...*types.Pair) (o *types.Object, err error)

Stat implements Storager.Stat

func (*Storage) StatWithContext

func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...*types.Pair) (o *types.Object, err error)

StatWithContext adds context support for Stat.

func (*Storage) String

func (s *Storage) String() string

String implements Storager.String

func (*Storage) Write

func (s *Storage) Write(path string, r io.Reader, pairs ...*types.Pair) (err error)

Write implements Storager.Write

func (*Storage) WriteWithContext

func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, pairs ...*types.Pair) (err error)

WriteWithContext adds context support for Write.