s3

Documentation

Index

• Variables
• type Option
• type Options
• type S3
• type Storage
  • func Must[T dynamo.Thing](keyval *Storage[T], err error) *Storage[T]
  • func New[T dynamo.Thing](bucket string, opt ...Option) (*Storage[T], error)
  • func (db *Storage[T]) Get(ctx context.Context, key T, opts ...interface{ GetterOpt(T) }) (T, error)
  • func (db *Storage[T]) Match(ctx context.Context, key T, opts ...interface{ MatcherOpt(T) }) ([]T, interface{ ... }, error)
  • func (db *Storage[T]) MatchKey(ctx context.Context, key dynamo.Thing, opts ...interface{ MatcherOpt(T) }) ([]T, interface{ ... }, error)
  • func (db *Storage[T]) Put(ctx context.Context, entity T, opts ...interface{ WriterOpt(T) }) error
  • func (db *Storage[T]) Remove(ctx context.Context, key T, opts ...interface{ WriterOpt(T) }) (T, error)
  • func (db *Storage[T]) Update(ctx context.Context, entity T, opts ...interface{ WriterOpt(T) }) (T, error)

Variables

var (
	// Configure CURIE prefixes
	WithPrefixes = opts.ForType[Options, curie.Prefixes]()

	// Set DynamoDB client for the client
	WithService = opts.ForType[Options, S3]()

	// Set DynamoDB client for the client
	WithS3 = opts.ForType[Options, S3]()

	// Configure client's DynamoDB to use provided the aws.Config
	WithConfig = opts.FMap(optsFromConfig)

	// Use default aws.Config for all DynamoDB clients
	WithDefaultS3 = opts.From(optsDefaultS3)
)

Types

type Option

type Option = opts.Option[Options]

Option type to configure the S3

type Options

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

Config Options

type S3

type S3 interface {
	GetObject(context.Context, *s3.GetObjectInput, ...func(*s3.Options)) (*s3.GetObjectOutput, error)
	PutObject(context.Context, *s3.PutObjectInput, ...func(*s3.Options)) (*s3.PutObjectOutput, error)
	DeleteObject(context.Context, *s3.DeleteObjectInput, ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)
	ListObjectsV2(context.Context, *s3.ListObjectsV2Input, ...func(*s3.Options)) (*s3.ListObjectsV2Output, error)
}

S3 declares AWS API used by the library

type Storage

type Storage[T dynamo.Thing] struct {
	Options
	// contains filtered or unexported fields
}

func Must

func Must[T dynamo.Thing](keyval *Storage[T], err error) *Storage[T]

Must constraint for api factory

func New

func New[T dynamo.Thing](bucket string, opt ...Option) (*Storage[T], error)

New creates instance of S3 api

func (*Storage[T]) Get

func (db *Storage[T]) Get(ctx context.Context, key T, opts ...interface{ GetterOpt(T) }) (T, error)

Get item from storage

func (*Storage[T]) Match

func (db *Storage[T]) Match(ctx context.Context, key T, opts ...interface{ MatcherOpt(T) }) ([]T, interface{ MatcherOpt(T) }, error)

func (*Storage[T]) MatchKey

func (db *Storage[T]) MatchKey(ctx context.Context, key dynamo.Thing, opts ...interface{ MatcherOpt(T) }) ([]T, interface{ MatcherOpt(T) }, error)

func (*Storage[T]) Put

func (db *Storage[T]) Put(ctx context.Context, entity T, opts ...interface{ WriterOpt(T) }) error

Put writes entity

func (*Storage[T]) Remove

func (db *Storage[T]) Remove(ctx context.Context, key T, opts ...interface{ WriterOpt(T) }) (T, error)

Remove discards the entity from the table

func (*Storage[T]) Update

func (db *Storage[T]) Update(ctx context.Context, entity T, opts ...interface{ WriterOpt(T) }) (T, error)

Update applies a partial patch to entity and returns new values