objects

type AttrsOption ¶

type AttrsOption interface {
	// contains filtered or unexported methods
}

AttrsOption describes available options for the Attrs operation.

type Attrser ¶

type Attrser interface {
	// Attrs resolves the attributes of an object.
	Attrs(ctx context.Context, object string, options ...AttrsOption) (*ObjectAttrs, error)

	// Exists checks whether an object exists in the bucket.
	Exists(ctx context.Context, object string, options ...ExistsOption) (bool, error)
}

Attrser is the interface for resolving objects' attributes in a bucket. It can be used in conjunction with BucketRef to declare a reference that can check object attributes in a bucket.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.Attrser](MyBucket)

The ref object can then be used to remove objects and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type Bucket ¶

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

Bucket represents an object storage bucket, containing a set of files.

See NewBucket for more information on how to declare a Bucket.

func Named(name constStr) (_ *Bucket)

func NewBucket(name string, cfg BucketConfig) (_ *Bucket)

func (*Bucket) Attrs(ctx context.Context, object string, options ...AttrsOption) (_ *ObjectAttrs, _ error)

func (*Bucket) Download(ctx context.Context, object string, options ...DownloadOption) (_ *Reader)

func (*Bucket) Exists(ctx context.Context, object string, options ...ExistsOption) (_ bool, _ error)

func (*Bucket) List(ctx context.Context, query *Query, options ...ListOption) (_ iter.Seq2[*ListEntry, error])

func (*Bucket) PublicURL(object string, options ...PublicURLOption) (_ *url.URL)

func (*Bucket) Remove(ctx context.Context, object string, options ...RemoveOption) (_ error)

func (*Bucket) SignedDownloadURL(ctx context.Context, object string, options ...DownloadURLOption) (_ *SignedDownloadURL, _ error)

func (*Bucket) SignedUploadURL(ctx context.Context, object string, options ...UploadURLOption) (_ *SignedUploadURL, _ error)

func (*Bucket) Upload(ctx context.Context, object string, options ...UploadOption) (_ *Writer)

type BucketConfig ¶

type BucketConfig struct {
	// Whether objects in the bucket should be publicly accessible, via CDN.
	Public bool

	// Whether objects stored in the bucket should be versioned.
	//
	// If true, the bucket will store multiple versions of each object
	// whenever it changes, as opposed to overwriting the old version.
	Versioned bool
}

BucketConfig is the configuration for a Bucket.

type BucketPerms ¶

type BucketPerms interface {
}

BucketPerms is the type constraint for all permission-declaring interfaces that can be used with BucketRef.

type DownloadOption ¶

type DownloadOption interface {
	// contains filtered or unexported methods
}

DownloadOption describes available options for the Download operation.

type DownloadURLOption ¶ added in v1.46.1

type DownloadURLOption interface {
	// contains filtered or unexported methods
}

DownloadURLOption describes available options for the SignedDownloadURL operation.

type Downloader ¶

type Downloader interface {
	// Download downloads an object from the bucket.
	Download(ctx context.Context, object string, options ...DownloadOption) *Reader
}

Downloader is the interface for downloading objects from a bucket. It can be used in conjunction with BucketRef to declare a reference that can download objects from the bucket.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.Downloader](MyBucket)

The ref object can then be used to download objects and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type ExistsOption ¶

type ExistsOption interface {
	// contains filtered or unexported methods
}

ExistsOption describes available options for the Exists operation.

type ListEntry ¶

type ListEntry struct {
	// The name of the object.
	Name string
	// The size of the object, in bytes.
	Size int64
	// The computed ETag of the object.
	ETag string
}

ListEntry describes an objects during listing.

type ListOption ¶

type ListOption interface {
	// contains filtered or unexported methods
}

ListOption describes available options for the List operation.

type Lister ¶

type Lister interface {
	// List lists objects in the bucket.
	List(ctx context.Context, query *Query, options ...ListOption) iter.Seq2[*ListEntry, error]
}

Lister is the interface for listing objects in a bucket. It can be used in conjunction with BucketRef to declare a reference that can list objects in the bucket.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.Lister](MyBucket)

The ref object can then be used to list objects and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type ObjectAttrs ¶

type ObjectAttrs struct {
	// The name of the object.
	Name string

	// The version of the object, if bucket versioning is enabled.
	Version string

	// The content type of the object, if set during upload.
	ContentType string

	// The size of the object, in bytes.
	Size int64

	// The computed ETag of the object.
	ETag string
}

ObjectAttrs describes the attributes of an object.

type Preconditions ¶

type Preconditions struct {
	// NotExists specifies that the object must not exist prior to uploading.
	NotExists bool
}

Preconditions are the available preconditions for an upload operation.

type PublicURLOption ¶ added in v1.44.6

type PublicURLOption interface {
	// contains filtered or unexported methods
}

PublicURLOption describes available options for the PublicURL operation.

type PublicURLer ¶ added in v1.44.6

type PublicURLer interface {
	// PublicURL resolves the public URL for retrieving an object.
	PublicURL(object string, options ...PublicURLOption) *url.URL
}

PublicURLer is the interface for resolving the public URL for an object. It can be used in conjunction with BucketRef to declare a reference that can resolve an object's public URL.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.PublicURLer](MyBucket)

The ref object can then be used to remove objects and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type Query ¶

type Query struct {
	// Prefix indicates to only return objects
	// whose name starts with the given prefix.
	Prefix string

	// Maximum number of objects to return. Zero means no limit.
	Limit int64
}

Query describes the set of objects to query for using List.

type ReadWriter ¶

type ReadWriter interface {
	Uploader
	SignedUploader
	Downloader
	SignedDownloader
	Remover
	Lister
	Attrser
}

ReadWriter is a utility permission interface that provides all the read-write permissions.

type Reader ¶

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

Reader is the reader for an object being downloaded from a bucket.

func (*Reader) Close() (_ error)

func (*Reader) Err() (_ error)

func (*Reader) Read(p []byte) (_ int, _ error)

type RemoveOption ¶

type RemoveOption interface {
	// contains filtered or unexported methods
}

RemoveOption describes available options for the Remove operation.

type Remover ¶

type Remover interface {
	// Remove removes an object from the bucket.
	Remove(ctx context.Context, object string, options ...RemoveOption) error
}

Remove is the interface for removing objects from a bucket. It can be used in conjunction with BucketRef to declare a reference that can remove objects from the bucket.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.Remover](MyBucket)

The ref object can then be used to remove objects and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type SignedDownloadURL ¶ added in v1.46.1

type SignedDownloadURL struct {
	// The signed URL
	URL string
}

type SignedDownloader ¶ added in v1.46.1

type SignedDownloader interface {
	// SignedDownloadURL returns a signed URL that can be used to download directly
	// from storage, without any other authentication.
	SignedDownloadURL(ctx context.Context, object string, options ...DownloadURLOption) (*SignedDownloadURL, error)
}

SignedDownloader is the interface for creating external URLs to download objects from a bucket. It can be used in conjunction with BucketRef to declare a reference that can generate download URLs for the bucket.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.SignedDownloader](MyBucket)

The ref object can then be used to generate download URLs and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type SignedUploadURL ¶ added in v1.46.1

type SignedUploadURL struct {
	// The signed URL
	URL string
}

type SignedUploader ¶ added in v1.46.1

type SignedUploader interface {
	// SignedUploadURL returns a signed URL that can be used to upload directly to
	// storage, without any other authentication.
	SignedUploadURL(ctx context.Context, object string, options ...UploadURLOption) (*SignedUploadURL, error)
}

SignedUploader is the interface for creating external URLs to upload objects to a bucket. It can be used in conjunction with BucketRef to declare a reference that can generate upload URLs to the bucket.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.SignedUploader](MyBucket)

The ref object can then be used to generate upload URLs and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type UploadAttrs ¶

type UploadAttrs struct {
	// ContentType specifies the content type of the object.
	ContentType string
}

UploadAttrs specifies additional object attributes to set during upload.

type UploadOption ¶

type UploadOption interface {
}

UploadOption describes available options for the Upload operation.

type UploadURLOption ¶ added in v1.46.1

type UploadURLOption interface {
	// contains filtered or unexported methods
}

UploadURLOption describes available options for the SignedUploadURL operation.

type Uploader ¶

type Uploader interface {
	// Upload begins uploading an object to the bucket.
	Upload(ctx context.Context, object string, options ...UploadOption) *Writer
}

Uploader is the interface for uploading objects to a bucket. It can be used in conjunction with BucketRef to declare a reference that can upload objects to the bucket.

For example:

var MyBucket = objects.NewBucket(...)
var ref = objects.BucketRef[objects.Uploader](MyBucket)

The ref object can then be used to upload objects and can be passed around freely within the service, without being subject to Encore's static analysis restrictions that apply to MyBucket.

type Writer ¶

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

Writer is the writer for an object being uploaded to a bucket.

func (*Writer) Abort(err error)

func (*Writer) Close() (_ error)

func (*Writer) Write(p []byte) (_ int, _ error)