s3io

package module

Go to main page

Versions in this module

v1

v1.0.1

Apr 22, 2024

Changes in this version

type ObjectReaderOption

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

type ObjectWriterOption

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

v1.0.0

Apr 22, 2024

Changes in this version

type ObjectReader

+ func NewObjectReader(ctx context.Context, cli *s3.Client, bucketName, key string, ...) (*ObjectReader, error)

+ type ObjectReaderOption func(*ObjectReader) error

+ func ObjectReaderOptions(opts ...ObjectReaderOption) ObjectReaderOption

type ObjectWriter

+ func NewObjectWriter(ctx context.Context, cli *s3.Client, bucketName, key string, ...) (*ObjectWriter, error)

+ type ObjectWriterOption func(*ObjectWriter) error

+ func ObjectWriterOptions(opts ...ObjectWriterOption) ObjectWriterOption

v0

v0.1.1

Apr 21, 2024

v0.1.0

Apr 21, 2024

Changes in this version

+ const DefaultChunkSize

+ const MinChunkSize

+ var ErrMinChunkSize = errors.New("given value is less than minimum chunksize of 5mb")

+ type Bucket struct

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

+ func OpenBucketkwithCli(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) NewReader(ctx context.Context, key string, opts ...ReaderOption) (io.Reader, error)

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

+ func (b *Bucket) NewWriterIfNotExists(ctx context.Context, key string, opts ...WriterOption) (io.WriteCloser, error)

+ type BucketOption func(*bucketBuilder) error

+ func BucketOptions(opts ...BucketOption) BucketOption

+ func WithBucketCli(cli *s3.Client) BucketOption

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

+ func WithBucketConcurrency(size uint8) 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 uint) BucketOption

+ func WithBucketRetries(i uint8) BucketOption

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

+ func WithBucketWriteChunkSize(size uint) BucketOption

+ type ObjectReader struct

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

+ type ObjectWriter struct

+ func (w *ObjectWriter) Close() error

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

+ type ReaderOption func(*ObjectReader) error

+ func ReaderOptions(ops ...ReaderOption) ReaderOption

+ func WithReaderChunkSize(size uint) ReaderOption

+ func WithReaderConcurrency(i uint8) ReaderOption

+ func WithReaderLogger(logger *slog.Logger) ReaderOption

+ func WithReaderRetries(i uint8) ReaderOption

+ type WriterOption func(*ObjectWriter) error

+ func WithWriteRetries(i uint8) WriterOption

+ func WithWriterACL(acl types.ObjectCannedACL) WriterOption

+ func WithWriterChunkSize(size uint) WriterOption

+ func WithWriterConcurrency(i uint8) WriterOption

+ func WithWriterLogger(logger *slog.Logger) WriterOption

+ func WriterOptions(ops ...WriterOption) WriterOption

Other modules containing this package

github.com/jobstoit/s3io/v2

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