s3io

README

AWS S3 Go io Interfaces

Implements io interfaces for AWS S3 objects in Go.

Work in progress, please dont use as I might squash git commits when done.

Documentation

Index

• func Create(bucket, key string, opts ...WriteOption) (*s3Writer, error)
• func CreateWithOptions(o WriteOptions, opts ...WriteOption) (*s3Writer, error)
• func CreateWithURI(URI string, opts ...WriteOption) (*s3Writer, error)
• func Open(bucket, key string, opts ...ReadOption) (*s3Reader, error)
• func OpenWithOptions(o ReadOptions, opts ...ReadOption) (*s3Reader, error)
• func OpenWithURI(URI string, opts ...ReadOption) (*s3Reader, error)
• func Remove(bucket, key string, opts ...DeleteOption) error
• func RemoveWithOptions(o DeleteOptions, opts ...DeleteOption) error
• func RemoveWithURI(URI string, opts ...DeleteOption) error
• func Stat(bucket, key string, opts ...StatOption) (*fileInfo, error)
• func StatWithOptions(o StatOptions, opts ...StatOption) (*fileInfo, error)
• func StatWithURI(URI string, opts ...StatOption) (*fileInfo, error)
• func WithBuffer(buf []byte) *withBuffer
• func WithClient(client *s3.Client) *withClient
• func WithContext(ctx context.Context) *withContext
• func WithDownloader(downloader *manager.Downloader) *withDownloader
• func WithUploader(uploader *manager.Uploader) *withUploader
• type DeleteOption
• type DeleteOptions
• type ReadOption
• type ReadOptions
• type StatOption
• type StatOptions
• type WriteOption
• type WriteOptions

Functions

func Create

func Create(
	bucket, key string,
	opts ...WriteOption,
) (*s3Writer, error)

func CreateWithOptions

func CreateWithOptions(
	o WriteOptions,
	opts ...WriteOption,
) (*s3Writer, error)

func CreateWithURI

func CreateWithURI(URI string, opts ...WriteOption) (*s3Writer, error)

func Open

func Open(
	bucket, key string,
	opts ...ReadOption,
) (*s3Reader, error)

func OpenWithOptions

func OpenWithOptions(
	o ReadOptions,
	opts ...ReadOption,
) (*s3Reader, error)

func OpenWithURI

func OpenWithURI(
	URI string,
	opts ...ReadOption,
) (*s3Reader, error)

func Remove

func Remove(
	bucket, key string,
	opts ...DeleteOption,
) error

func RemoveWithOptions

func RemoveWithOptions(
	o DeleteOptions,
	opts ...DeleteOption,
) error

func RemoveWithURI

func RemoveWithURI(URI string, opts ...DeleteOption) error

func Stat

func Stat(
	bucket, key string,
	opts ...StatOption,
) (*fileInfo, error)

func StatWithOptions

func StatWithOptions(
	o StatOptions,
	opts ...StatOption,
) (*fileInfo, error)

func StatWithURI

func StatWithURI(
	URI string,
	opts ...StatOption,
) (*fileInfo, error)

func WithBuffer

func WithBuffer(buf []byte) *withBuffer

func WithClient

func WithClient(client *s3.Client) *withClient

func WithContext

func WithContext(ctx context.Context) *withContext

func WithDownloader

func WithDownloader(downloader *manager.Downloader) *withDownloader

func WithUploader

func WithUploader(uploader *manager.Uploader) *withUploader

Types

type DeleteOption

type DeleteOption interface {
	ApplyDeleteOption(*DeleteOptions)
}

type DeleteOptions

type DeleteOptions struct {
	s3.DeleteObjectInput
	// contains filtered or unexported fields
}

type ReadOption

type ReadOption interface {
	ApplyReadOption(*ReadOptions)
}

type ReadOptions

type ReadOptions struct {
	s3.GetObjectInput
	// contains filtered or unexported fields
}

type StatOption

type StatOption interface {
	ApplyStatOption(*StatOptions)
}

type StatOptions

type StatOptions struct {
	s3.HeadObjectInput
	// contains filtered or unexported fields
}

type WriteOption

type WriteOption interface {
	ApplyWriteOption(*WriteOptions)
}

type WriteOptions

type WriteOptions struct {
	s3.PutObjectInput
	// contains filtered or unexported fields
}