Documentation
¶
Overview ¶
Package r2 is the Cloudflare R2 storage provider for objects service
Index ¶
- Constants
- Variables
- func NewR2ProviderFromCredentials(credentials storage.ProviderCredentials, options *storage.ProviderOptions) mo.Result[storagetypes.Provider]
- type Builder
- type Option
- type Provider
- func (p *Provider) Close() error
- func (p *Provider) Delete(ctx context.Context, file *storagetypes.File, ...) error
- func (p *Provider) Download(ctx context.Context, file *storagetypes.File, ...) (*storagetypes.DownloadedFileMetadata, error)
- func (p *Provider) Exists(ctx context.Context, file *storagetypes.File) (bool, error)
- func (p *Provider) GetPresignedURL(ctx context.Context, file *storagetypes.File, ...) (string, error)
- func (p *Provider) GetScheme() *string
- func (p *Provider) ListBuckets() ([]string, error)
- func (p *Provider) ProviderType() storagetypes.ProviderType
- func (p *Provider) Upload(ctx context.Context, reader io.Reader, opts *storagetypes.UploadFileOptions) (*storagetypes.UploadedFileMetadata, error)
Constants ¶
View Source
const ( // DefaultPresignedURLExpiry defines the default expiry time for presigned URLs DefaultPresignedURLExpiry = 15 * time.Minute // DefaultPartSize defines the default part size for multipart uploads (64MB) DefaultPartSize = 64 * 1024 * 1024 // DefaultConcurrency defines the default concurrency for uploads DefaultConcurrency = 5 )
Variables ¶
View Source
var ( // ErrR2CredentialsRequired is returned when required R2 credentials are missing ErrR2CredentialsRequired = errors.New("missing required R2 credentials: bucket, account_id, access_key_id, secret_access_key") // ErrR2BucketRequired is returned when R2 bucket is not specified ErrR2BucketRequired = errors.New("R2 bucket is required") // ErrR2AccountIDRequired is returned when R2 account ID is not specified ErrR2AccountIDRequired = errors.New("R2 account ID is required") // ErrR2CredentialsMissing is returned when R2 access keys are missing ErrR2CredentialsMissing = errors.New("R2 access key ID and secret access key are required") )
Functions ¶
func NewR2ProviderFromCredentials ¶
func NewR2ProviderFromCredentials(credentials storage.ProviderCredentials, options *storage.ProviderOptions) mo.Result[storagetypes.Provider]
NewR2ProviderFromCredentials creates an R2 provider using the supplied credentials and options
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder creates R2 providers for the client pool
func (*Builder) Build ¶
func (b *Builder) Build(_ context.Context, credentials storage.ProviderCredentials, config *storage.ProviderOptions) (storagetypes.Provider, error)
Build implements eddy.Builder
func (*Builder) ProviderType ¶
ProviderType implements eddy.Builder
func (*Builder) WithOptions ¶ added in v0.39.2
WithOptions sets provider options for the builder
type Option ¶ added in v0.39.2
type Option func(*providerConfig)
Option configures the R2 provider during construction
func WithUsePathStyle ¶ added in v0.39.2
WithUsePathStyle configures the R2 client to use path-style addressing
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider implements the storagetypes.Provider interface for Cloudflare R2
func NewR2Provider ¶
func NewR2Provider(options *storage.ProviderOptions, opts ...Option) (*Provider, error)
NewR2Provider creates a new R2 provider instance
func (*Provider) Delete ¶
func (p *Provider) Delete(ctx context.Context, file *storagetypes.File, _ *storagetypes.DeleteFileOptions) error
Delete implements storagetypes.Provider
func (*Provider) Download ¶
func (p *Provider) Download(ctx context.Context, file *storagetypes.File, _ *storagetypes.DownloadFileOptions) (*storagetypes.DownloadedFileMetadata, error)
Download implements storagetypes.Provider
func (*Provider) GetPresignedURL ¶
func (p *Provider) GetPresignedURL(ctx context.Context, file *storagetypes.File, opts *storagetypes.PresignedURLOptions) (string, error)
GetPresignedURL implements storagetypes.Provider
func (*Provider) ListBuckets ¶
ListBuckets lists the buckets in the current account.
func (*Provider) ProviderType ¶
func (p *Provider) ProviderType() storagetypes.ProviderType
func (*Provider) Upload ¶
func (p *Provider) Upload(ctx context.Context, reader io.Reader, opts *storagetypes.UploadFileOptions) (*storagetypes.UploadedFileMetadata, error)
Upload implements storagetypes.Provider
Source Files
Click to show internal directories.
Click to hide internal directories.