simplestorage

package

Go to main page

Versions in this module

v0

v0.8.0

Aug 11, 2026

v0.7.0

Jun 2, 2026

Changes in this version

+ type AccessType string

+ const AccessPrivate

+ const AccessPublic

type BucketOption

+ func WithBucketAccess(access AccessType) BucketOption

+ func WithConsistentRead() BucketOption

+ func WithDefaultTier(tier string) BucketOption

+ func WithForkSourceSnapshot(snapshot string) BucketOption

+ func WithGrabForkInfo() BucketOption

type BucketOptions

+ Access AccessType

+ Consistency string

+ DefaultTier string

+ GrabForkInfo bool

+ SourceBucketSnapshot string

type Client

+ func (c *Client) Buckets(ctx context.Context, opts ...BucketOption) iter.Seq2[*BucketInfo, error]

+ func (c *Client) Info(ctx context.Context, bucket string, opts ...BucketOption) (*BucketInfo, error)

+ func (c *Client) Snapshot(ctx context.Context, bucket, description string, opts ...BucketOption) (*SnapshotInfo, error)

+ func (c *Client) Snapshots(ctx context.Context, bucket string, opts ...BucketOption) iter.Seq2[*SnapshotInfo, error]

type ClientOption

+ func WithAccessType(access AccessType) ClientOption

+ func WithAllowOverwrite(allow bool) ClientOption

+ func WithMultipartUpload(threshold int64) ClientOption

+ func WithQuerySnapshotVersion(version string) ClientOption

+ func WithRandomSuffix() ClientOption

+ func WithResponseCacheControl(cacheControl string) ClientOption

+ func WithResponseContentDisposition(disposition string) ClientOption

+ func WithResponseContentType(contentType string) ClientOption

+ func WithUploadProgress(callback func(UploadProgress)) ClientOption

type ClientOptions

+ AccessType AccessType

+ AllowOverwrite *bool

+ MultipartThreshold *int64

+ RandomSuffix bool

+ ResponseCacheControl *string

+ ResponseContentDisposition *string

+ ResponseContentType *string

+ SnapshotVersion *string

+ UploadProgressCallback func(UploadProgress)

+ type ListOption func(*listOptions)

+ func WithContinueToken(token string) ListOption

+ func WithListS3Options(opts ...func(*s3.Options)) ListOption

+ type UploadProgress struct

+ Loaded int64

+ Percentage float64

+ Total int64

v0.6.0

Apr 6, 2026

v0.5.0

Jan 30, 2026

Changes in this version

type Client

+ func (c *Client) For(bucket string) *Client

+ func (c *Client) PresignURL(ctx context.Context, method string, key string, expiry time.Duration, ...) (string, error)

type ClientOption

+ func WithContentDisposition(disposition string) ClientOption

+ func WithContentType(contentType string) ClientOption

type ClientOptions

+ ContentDisposition *string

+ ContentType *string

v0.4.1

Jan 27, 2026

v0.4.0

Jan 26, 2026

Changes in this version

type Client

+ func (c *Client) Head(ctx context.Context, key string, opts ...ClientOption) (*Object, error)

type Object

+ Metadata map[string]string

v0.3.0

Jan 26, 2026

Changes in this version

type ClientOption

+ func WithDelimiter(delimiter string) ClientOption

+ func WithPaginationToken(token string) ClientOption

+ func WithPrefix(prefix string) ClientOption

type ClientOptions

+ Delimiter *string

+ PaginationToken *string

+ Prefix *string

+ type ListResult struct

+ HasMore bool

+ Items []Object

+ NextToken string

type Object

+ ContentDisposition string

+ URL string

v0.2.0

Jan 15, 2026

Changes in this version

+ var ErrBucketNameRequired = errors.New("simplestorage: bucket name required for bucket management operations")

+ var ErrBucketNotEmpty = errors.New("simplestorage: bucket not empty")

+ var ErrBucketNotFound = errors.New("simplestorage: bucket not found")

+ var ErrNoBucketName = errors.New(...)

+ var ErrSnapshotRequired = errors.New("simplestorage: snapshot version required for this operation")

+ type BucketInfo struct

+ Created time.Time

+ IsForkParent bool

+ Name string

+ SnapshotsEnabled bool

+ SourceBucket string

+ SourceSnapshot string

+ type BucketList struct

+ Buckets []BucketInfo

+ NextToken string

+ Truncated bool

+ type BucketOption func(*BucketOptions)

+ func WithBucketRegion(region string) BucketOption

+ func WithEnableSnapshot() BucketOption

+ func WithListLimit(limit int32) BucketOption

+ func WithListToken(token string) BucketOption

+ func WithSnapshotVersion(version string) BucketOption

+ type BucketOptions struct

+ ContinuationToken *string

+ EnableSnapshot bool

+ MaxKeys *int32

+ Region string

+ S3Options []func(*s3.Options)

+ SnapshotVersion string

+ type Client struct

+ func New(ctx context.Context, options ...Option) (*Client, error)

+ func (c *Client) CreateBucket(ctx context.Context, bucket string, opts ...BucketOption) (*BucketInfo, error)

+ func (c *Client) CreateBucketSnapshot(ctx context.Context, bucket, description string, opts ...BucketOption) (*SnapshotInfo, error)

+ func (c *Client) Delete(ctx context.Context, key string, opts ...ClientOption) error

+ func (c *Client) DeleteBucket(ctx context.Context, bucket string, opts ...BucketOption) error

+ func (c *Client) ForkBucket(ctx context.Context, source, target string, opts ...BucketOption) (*BucketInfo, error)

+ func (c *Client) Get(ctx context.Context, key string, opts ...ClientOption) (*Object, error)

+ func (c *Client) GetBucketInfo(ctx context.Context, bucket string, opts ...BucketOption) (*BucketInfo, error)

+ func (c *Client) List(ctx context.Context, prefix string, opts ...ClientOption) ([]Object, error)

+ func (c *Client) ListBucketSnapshots(ctx context.Context, bucket string, opts ...BucketOption) (*SnapshotList, error)

+ func (c *Client) ListBuckets(ctx context.Context, opts ...BucketOption) (*BucketList, error)

+ func (c *Client) Put(ctx context.Context, obj *Object, opts ...ClientOption) (*Object, error)

+ type ClientOption func(*ClientOptions)

+ func OverrideBucket(bucket string) ClientOption

+ func WithMaxKeys(maxKeys int32) ClientOption

+ func WithS3Options(opts ...func(*s3.Options)) ClientOption

+ func WithStartAfter(startAfter string) ClientOption

+ type ClientOptions struct

+ BucketName string

+ MaxKeys *int32

+ S3Options []func(*s3.Options)

+ StartAfter *string

+ type Object struct

+ Body io.ReadCloser

+ Bucket string

+ ContentType string

+ Etag string

+ Key string

+ LastModified time.Time

+ Size int64

+ Version string

+ type Option func(o *Options)

+ func WithAccessKeypair(accessKeyID, secretAccessKey string) Option

+ func WithBucket(bucketName string) Option

+ func WithEndpoint(endpoint string) Option

+ func WithFlyEndpoint() Option

+ func WithGlobalEndpoint() Option

+ func WithPathStyle(enabled bool) Option

+ func WithRegion(region string) Option

+ type Options struct

+ AccessKeyID string

+ BaseEndpoint string

+ BucketName string

+ Region string

+ SecretAccessKey string

+ UsePathStyle bool

+ type SnapshotInfo struct

+ Bucket string

+ Created time.Time

+ Name string

+ Version string

+ type SnapshotList struct

+ Bucket string

+ Snapshots []SnapshotInfo

v0.1.0

Jan 14, 2026

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