s3journal

Documentation

Overview

Package s3journal provides an implementation of journal.BinaryStore that persists to an S3 bucket.

Index

• func NewBinaryStore(client *s3.Client, bucket string, options ...Option) journal.BinaryStore
• type Option
  • func WithRequestHook(fn func(any) []func(*s3.Options)) Option

Functions

func NewBinaryStore

func NewBinaryStore(
	client *s3.Client,
	bucket string,
	options ...Option,
) journal.BinaryStore

NewBinaryStore returns a new journal.BinaryStore that uses the given S3 client to store journal records in the given bucket.

Types

type Option

type Option func(*store)

Option is a functional option that changes the behavior of NewBinaryStore.

func WithRequestHook

func WithRequestHook(fn func(any) []func(*s3.Options)) Option

WithRequestHook is an Option that configures fn as a pre-request hook.

Before each S3 API request, fn is passed a pointer to the input struct, e.g. s3.GetObjectInput, which it may modify in-place. It may be called with any S3 request type. The types of requests used may change in any version without notice.

Any functions returned by fn will be applied to the request's options before the request is sent.