s3io

May 13, 2024

Changes in this version

type ObjectWriterOption

+ func WithWriterACL(acl types.ObjectCannedACL) ObjectWriterOption

May 11, 2024

Changes in this version

+ func ReadAll(ctx context.Context, s3 DownloadAPIClient, input *s3.GetObjectInput, ...) ([]byte, error)

+ func WriteAllBytes(ctx context.Context, s3 UploadAPIClient, input *s3.PutObjectInput, p []byte, ...) (int, error)

+ func WriteAllFromBody(ctx context.Context, s3 UploadAPIClient, input *s3.PutObjectInput, ...) (int64, error)

type Bucket

+ func (b *Bucket) ReadAll(ctx context.Context, key string, opts ...ObjectReaderOption) ([]byte, error)

+ func (b *Bucket) WriteAll(ctx context.Context, key string, p []byte, opts ...ObjectWriterOption) (int, error)

+ func (b *Bucket) WriteFrom(ctx context.Context, key string, from io.Reader, opts ...ObjectWriterOption) (int64, error)

Apr 30, 2024

Changes in this version

+ const DefaultChunkSize

+ const MinChunkSize

+ func NewObjectReader(ctx context.Context, s3 DownloadAPIClient, input *s3.GetObjectInput, ...) io.Reader

+ func NewObjectWriter(ctx context.Context, s3 UploadAPIClient, input *s3.PutObjectInput, ...) io.WriteCloser

+ type Bucket struct

+ func OpenBucket(ctx context.Context, name string, opts ...BucketOption) (*Bucket, error)

+ func OpenBucketkwithClient(ctx context.Context, cli *s3.Client, name string, opts ...BucketOption) (*Bucket, error)

+ func (b *Bucket) Client() *s3.Client

+ func (b *Bucket) Delete(ctx context.Context, keys ...string) error

+ func (b *Bucket) Exists(ctx context.Context, key string) (bool, error)

+ func (b *Bucket) List(ctx context.Context, prefix string) ([]types.Object, error)

+ func (b *Bucket) Name() string

+ func (b *Bucket) NewReader(ctx context.Context, key string, opts ...ObjectReaderOption) io.Reader

+ func (b *Bucket) NewWriter(ctx context.Context, key string, opts ...ObjectWriterOption) io.WriteCloser

+ type BucketOption func(*bucketBuilder)

+ func BucketOptions(opts ...BucketOption) BucketOption

+ func WithBucketCli(cli *s3.Client) BucketOption

+ func WithBucketCliLoaderOptions(opts ...func(*config.LoadOptions) error) BucketOption

+ func WithBucketConcurrency(size int) BucketOption

+ func WithBucketCreateIfNotExists() BucketOption

+ func WithBucketCredentials(accessKey, secretKey string) BucketOption

+ func WithBucketHost(url, region string, usePathStyle bool) BucketOption

+ func WithBucketLogger(logger *slog.Logger) BucketOption

+ func WithBucketReadChunkSize(size int64) BucketOption

+ func WithBucketRetries(i int) BucketOption

+ func WithBucketS3Options(opts ...func(*s3.Options)) BucketOption

+ func WithBucketWriteChunkSize(size int64) BucketOption

+ type DownloadAPIClient interface

+ GetObject func(context.Context, *s3.GetObjectInput, ...func(*s3.Options)) (*s3.GetObjectOutput, error)

+ type ObjectReader struct

+ func (r *ObjectReader) Read(p []byte) (int, error)

+ type ObjectReaderOption func(*ObjectReader)

+ func ObjectReaderOptions(opts ...ObjectReaderOption) ObjectReaderOption

+ func WithReaderChunkSize(size int64) ObjectReaderOption

+ func WithReaderConcurrency(i int) ObjectReaderOption

+ func WithReaderLogger(logger *slog.Logger) ObjectReaderOption

+ func WithReaderRetries(i int) ObjectReaderOption

+ func WithReaderS3Options(opts ...func(*s3.Options)) ObjectReaderOption

+ type ObjectWriter struct

+ func (w *ObjectWriter) Close() error

+ func (w *ObjectWriter) Write(p []byte) (int, error)

+ type ObjectWriterOption func(*ObjectWriter)

+ func ObjectWriterOptions(opts ...ObjectWriterOption) ObjectWriterOption

+ func WithWriteRetries(i int) ObjectWriterOption

+ func WithWriterChunkSize(size int64) ObjectWriterOption

+ func WithWriterClientOptions(opts ...func(*s3.Options)) ObjectWriterOption

+ func WithWriterConcurrency(i int) ObjectWriterOption

+ func WithWriterLogger(logger *slog.Logger) ObjectWriterOption

+ type UploadAPIClient interface

+ AbortMultipartUpload func(context.Context, *s3.AbortMultipartUploadInput, ...func(*s3.Options)) (*s3.AbortMultipartUploadOutput, error)

+ CompleteMultipartUpload func(context.Context, *s3.CompleteMultipartUploadInput, ...func(*s3.Options)) (*s3.CompleteMultipartUploadOutput, error)

+ CreateMultipartUpload func(context.Context, *s3.CreateMultipartUploadInput, ...func(*s3.Options)) (*s3.CreateMultipartUploadOutput, error)

+ PutObject func(context.Context, *s3.PutObjectInput, ...func(*s3.Options)) (*s3.PutObjectOutput, error)

+ UploadPart func(context.Context, *s3.UploadPartInput, ...func(*s3.Options)) (*s3.UploadPartOutput, error)