s3

package

v0.0.1-beta Latest Latest Go to latest Published: Jan 26, 2024 License: Apache-2.0, MIT Imports: 28 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jiaozifs/jiaozifs

Documentation ¶

Index ¶

Variables
func ExtractParamsFromQK(qk block.QualifiedKey) (string, string)
func LoadConfig(ctx context.Context, params params.S3) (aws.Config, error)
func WithClientParams(params params.S3) func(options *s3.Options)
func WithDisablePreSigned(b bool) func(a *Adapter)
func WithDisablePreSignedUI(b bool) func(a *Adapter)
func WithDiscoverBucketRegion(b bool) func(a *Adapter)
func WithPreSignedExpiry(v time.Duration) func(a *Adapter)
func WithServerSideEncryption(s string) func(a *Adapter)
func WithServerSideEncryptionKmsKeyID(s string) func(a *Adapter)
type Adapter
- func NewAdapter(ctx context.Context, params params.S3, opts ...AdapterOption) (*Adapter, error)
- func (a *Adapter) AbortMultiPartUpload(ctx context.Context, obj block.ObjectPointer, uploadID string) error
- func (a *Adapter) BlockstoreType() string
- func (a *Adapter) CompleteMultiPartUpload(ctx context.Context, obj block.ObjectPointer, uploadID string, ...) (*block.CompleteMultiPartUploadResponse, error)
- func (a *Adapter) Copy(ctx context.Context, sourceObj, destinationObj block.ObjectPointer) error
- func (a *Adapter) CreateMultiPartUpload(ctx context.Context, obj block.ObjectPointer, _ *http.Request, ...) (*block.CreateMultiPartUploadResponse, error)
- func (a *Adapter) Exists(ctx context.Context, obj block.ObjectPointer) (bool, error)
- func (a *Adapter) Get(ctx context.Context, obj block.ObjectPointer, _ int64) (io.ReadCloser, error)
- func (a *Adapter) GetPreSignedURL(ctx context.Context, obj block.ObjectPointer, mode block.PreSignMode) (string, time.Time, error)
- func (a *Adapter) GetProperties(ctx context.Context, obj block.ObjectPointer) (block.Properties, error)
- func (a *Adapter) GetRange(ctx context.Context, obj block.ObjectPointer, startPosition int64, ...) (io.ReadCloser, error)
- func (a *Adapter) GetStorageNamespaceInfo() block.StorageNamespaceInfo
- func (a *Adapter) GetWalker(uri *url.URL) (block.Walker, error)
- func (a *Adapter) Put(ctx context.Context, obj block.ObjectPointer, sizeBytes int64, ...) error
- func (a *Adapter) Remove(ctx context.Context, obj block.ObjectPointer) error
- func (a *Adapter) RemoveNameSpace(ctx context.Context, namespace string) error
- func (a *Adapter) ResolveNamespace(storageNamespace, key string, identifierType block.IdentifierType) (block.QualifiedKey, error)
- func (a *Adapter) RuntimeStats() map[string]string
- func (a *Adapter) UploadCopyPart(ctx context.Context, sourceObj, destinationObj block.ObjectPointer, ...) (*block.UploadPartResponse, error)
- func (a *Adapter) UploadCopyPartRange(ctx context.Context, sourceObj, destinationObj block.ObjectPointer, ...) (*block.UploadPartResponse, error)
- func (a *Adapter) UploadPart(ctx context.Context, obj block.ObjectPointer, sizeBytes int64, ...) (*block.UploadPartResponse, error)
type AdapterOption
type CaptureExpiresPresigner
- func (c *CaptureExpiresPresigner) PresignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, ...) (url string, signedHeader http.Header, err error)
type ClientCache
- func NewClientCache(awsConfig aws.Config, params params.S3) *ClientCache
- func (c *ClientCache) DiscoverBucketRegion(b bool)
- func (c *ClientCache) Get(ctx context.Context, bucket string) *s3.Client
- func (c *ClientCache) GetDefault() *s3.Client
- func (c *ClientCache) SetClientFactory(clientFactory clientFactory)
- func (c *ClientCache) SetS3RegionGetter(s3RegionGetter s3RegionGetter)
type Walker
- func NewS3Walker(client *s3.Client) *Walker
- func (s *Walker) GetSkippedEntries() []block.ObjectStoreEntry
- func (s *Walker) Marker() block.Mark
- func (s *Walker) Walk(ctx context.Context, storageURI *url.URL, op block.WalkOptions, ...) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrS3          = errors.New("s3 error")
	ErrMissingETag = fmt.Errorf("%w: missing ETag", ErrS3)
)

Functions ¶

func ExtractParamsFromQK ¶

func ExtractParamsFromQK(qk block.QualifiedKey) (string, string)

func LoadConfig ¶

func LoadConfig(ctx context.Context, params params.S3) (aws.Config, error)

func WithClientParams ¶

func WithClientParams(params params.S3) func(options *s3.Options)

func WithDisablePreSigned ¶

func WithDisablePreSigned(b bool) func(a *Adapter)

func WithDisablePreSignedUI ¶

func WithDisablePreSignedUI(b bool) func(a *Adapter)

func WithDiscoverBucketRegion ¶

func WithDiscoverBucketRegion(b bool) func(a *Adapter)

func WithPreSignedExpiry ¶

func WithPreSignedExpiry(v time.Duration) func(a *Adapter)

func WithServerSideEncryption ¶

func WithServerSideEncryption(s string) func(a *Adapter)

func WithServerSideEncryptionKmsKeyID ¶

func WithServerSideEncryptionKmsKeyID(s string) func(a *Adapter)

Types ¶

type Adapter ¶

type Adapter struct {
	ServerSideEncryption         string
	ServerSideEncryptionKmsKeyID string
	// contains filtered or unexported fields
}

func NewAdapter ¶

func NewAdapter(ctx context.Context, params params.S3, opts ...AdapterOption) (*Adapter, error)

func (*Adapter) AbortMultiPartUpload ¶

func (a *Adapter) AbortMultiPartUpload(ctx context.Context, obj block.ObjectPointer, uploadID string) error

func (*Adapter) BlockstoreType ¶

func (a *Adapter) BlockstoreType() string

func (*Adapter) CompleteMultiPartUpload ¶

func (a *Adapter) CompleteMultiPartUpload(ctx context.Context, obj block.ObjectPointer, uploadID string, multipartList *block.MultipartUploadCompletion) (*block.CompleteMultiPartUploadResponse, error)

func (*Adapter) Copy ¶

func (a *Adapter) Copy(ctx context.Context, sourceObj, destinationObj block.ObjectPointer) error

func (*Adapter) CreateMultiPartUpload ¶

func (a *Adapter) CreateMultiPartUpload(ctx context.Context, obj block.ObjectPointer, _ *http.Request, opts block.CreateMultiPartUploadOpts) (*block.CreateMultiPartUploadResponse, error)

func (*Adapter) Exists ¶

func (a *Adapter) Exists(ctx context.Context, obj block.ObjectPointer) (bool, error)

func (*Adapter) Get ¶

func (a *Adapter) Get(ctx context.Context, obj block.ObjectPointer, _ int64) (io.ReadCloser, error)

func (*Adapter) GetPreSignedURL ¶

func (a *Adapter) GetPreSignedURL(ctx context.Context, obj block.ObjectPointer, mode block.PreSignMode) (string, time.Time, error)

func (*Adapter) GetProperties ¶

func (a *Adapter) GetProperties(ctx context.Context, obj block.ObjectPointer) (block.Properties, error)

func (*Adapter) GetRange ¶

func (a *Adapter) GetRange(ctx context.Context, obj block.ObjectPointer, startPosition int64, endPosition int64) (io.ReadCloser, error)

func (*Adapter) GetStorageNamespaceInfo ¶

func (a *Adapter) GetStorageNamespaceInfo() block.StorageNamespaceInfo

func (*Adapter) GetWalker ¶

func (a *Adapter) GetWalker(uri *url.URL) (block.Walker, error)

func (*Adapter) Put ¶

func (a *Adapter) Put(ctx context.Context, obj block.ObjectPointer, sizeBytes int64, reader io.Reader, opts block.PutOpts) error

func (*Adapter) Remove ¶

func (a *Adapter) Remove(ctx context.Context, obj block.ObjectPointer) error

func (*Adapter) RemoveNameSpace ¶

func (a *Adapter) RemoveNameSpace(ctx context.Context, namespace string) error

func (*Adapter) ResolveNamespace ¶

func (a *Adapter) ResolveNamespace(storageNamespace, key string, identifierType block.IdentifierType) (block.QualifiedKey, error)

func (*Adapter) RuntimeStats ¶

func (a *Adapter) RuntimeStats() map[string]string

func (*Adapter) UploadCopyPart ¶

func (a *Adapter) UploadCopyPart(ctx context.Context, sourceObj, destinationObj block.ObjectPointer, uploadID string, partNumber int) (*block.UploadPartResponse, error)

func (*Adapter) UploadCopyPartRange ¶

func (a *Adapter) UploadCopyPartRange(ctx context.Context, sourceObj, destinationObj block.ObjectPointer, uploadID string, partNumber int, startPosition, endPosition int64) (*block.UploadPartResponse, error)

func (*Adapter) UploadPart ¶

func (a *Adapter) UploadPart(ctx context.Context, obj block.ObjectPointer, sizeBytes int64, reader io.Reader, uploadID string, partNumber int) (*block.UploadPartResponse, error)

type AdapterOption ¶

type AdapterOption func(a *Adapter)

type CaptureExpiresPresigner ¶

type CaptureExpiresPresigner struct {
	Presigner            s3.HTTPPresignerV4
	CredentialsCanExpire bool
	CredentialsExpireAt  time.Time
}

func (*CaptureExpiresPresigner) PresignHTTP ¶

func (c *CaptureExpiresPresigner) PresignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) (url string, signedHeader http.Header, err error)

type ClientCache ¶

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

func NewClientCache ¶

func NewClientCache(awsConfig aws.Config, params params.S3) *ClientCache

func (*ClientCache) DiscoverBucketRegion ¶

func (c *ClientCache) DiscoverBucketRegion(b bool)

func (*ClientCache) Get ¶

func (c *ClientCache) Get(ctx context.Context, bucket string) *s3.Client

func (*ClientCache) GetDefault ¶

func (c *ClientCache) GetDefault() *s3.Client

func (*ClientCache) SetClientFactory ¶

func (c *ClientCache) SetClientFactory(clientFactory clientFactory)

func (*ClientCache) SetS3RegionGetter ¶

func (c *ClientCache) SetS3RegionGetter(s3RegionGetter s3RegionGetter)

type Walker ¶

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

func NewS3Walker ¶

func NewS3Walker(client *s3.Client) *Walker

func (*Walker) GetSkippedEntries ¶

func (s *Walker) GetSkippedEntries() []block.ObjectStoreEntry

func (*Walker) Marker ¶

func (s *Walker) Marker() block.Mark

func (*Walker) Walk ¶

func (s *Walker) Walk(ctx context.Context, storageURI *url.URL, op block.WalkOptions, walkFn func(e block.ObjectStoreEntry) error) error

Source Files ¶

View all Source files

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