blaze

Mar 12, 2024

Changes in this version

type Bucket

+ func (b *Bucket) RedirectAction(field, endpoint string) *fire.Action

Jun 12, 2023

Changes in this version

+ func Assign(ctx context.Context, store *coal.Store, bucket *Bucket, model coal.Model, ...) error

Nov 4, 2022

Changes in this version

+ type Registry struct

Sep 6, 2022

Changes in this version

+ var ErrExistingLink = xo.BF("existing link")

+ func Attach(ctx context.Context, store *coal.Store, bucket *Bucket, model coal.Model, ...) error

Jul 17, 2022

Changes in this version

+ func EnsureService(name string) coal.Migration

+ func NewRegistry(bindings ...*Binding) *stick.Registry[*Binding]

+ func TestService(t Tester, svc Service)

+ func TestServiceSeek(t Tester, svc Service)

type Binding

+ FileName string

+ Model coal.Model

+ func (b *Binding) Validate() error

+ type Bucket struct

+ func NewBucket(store *coal.Store, notary *heat.Notary, bindings ...*Binding) *Bucket

+ func (b *Bucket) Claim(ctx context.Context, model coal.Model, field string) error

+ func (b *Bucket) ClaimFile(ctx context.Context, claimKey, binding string, owner coal.ID) (*File, error)

+ func (b *Bucket) ClaimLink(ctx context.Context, link *Link, binding string, owner coal.ID) error

+ func (b *Bucket) CleanupFile(ctx context.Context, id coal.ID) error

+ func (b *Bucket) CleanupTask(retention time.Duration, batch int) *axe.Task

+ func (b *Bucket) Decorate(ctx context.Context, link *Link) error

+ func (b *Bucket) Decorator(fields ...string) *fire.Callback

+ func (b *Bucket) Download(ctx context.Context, viewKey string) (Download, *File, error)

+ func (b *Bucket) DownloadAction() *fire.Action

+ func (b *Bucket) DownloadFile(ctx context.Context, id coal.ID) (Download, *File, error)

+ func (b *Bucket) GetViewKey(ctx context.Context, file coal.ID) (string, error)

+ func (b *Bucket) MigrateFile(ctx context.Context, id coal.ID) error

+ func (b *Bucket) MigrateTask(services []string, batch int) *axe.Task

+ func (b *Bucket) Modifier(fields ...string) *fire.Callback

+ func (b *Bucket) Release(ctx context.Context, model coal.Model, field string) error

+ func (b *Bucket) ReleaseFile(ctx context.Context, file coal.ID) error

+ func (b *Bucket) ReleaseLink(ctx context.Context, link *Link) error

+ func (b *Bucket) Upload(ctx context.Context, name, mediaType string, size int64, ...) (string, *File, error)

+ func (b *Bucket) UploadAction(limit int64) *fire.Action

+ func (b *Bucket) Use(service Service, name string, upload bool)

type Download

+ func SeekableDownload(size int64, source func(offset int64) (io.ReadCloser, error)) Download

type File

+ Service string

type GridFS

+ func (g *GridFS) Lookup(ctx context.Context, handle Handle) (Info, error)

+ type Info struct

+ MediaType string

+ Size int64

type Memory

+ func (m *Memory) Lookup(_ context.Context, handle Handle) (Info, error)

+ type MigrateJob struct

+ type Minio struct

+ func NewMinio(client *minio.Client, bucket string) *Minio

+ func (m *Minio) Delete(ctx context.Context, handle Handle) error

+ func (m *Minio) Download(ctx context.Context, handle Handle) (Download, error)

+ func (m *Minio) Lookup(ctx context.Context, handle Handle) (Info, error)

+ func (m *Minio) Prepare(context.Context) (Handle, error)

+ func (m *Minio) Upload(ctx context.Context, handle Handle, info Info) (Upload, error)

type Service

+ Lookup func(ctx context.Context, handle Handle) (Info, error)

+ type Tester interface

+ Errorf func(format string, args ...interface{})

type Upload

+ func PipeUpload(fn func(upload io.Reader) error) Upload

Sep 9, 2021

Changes in this version

+ func IsValidLink(requireFilename bool, whitelist ...string) func(sub stick.Subject) error

+ func IsValidLinks(uniqueFilenames bool, whitelist ...string) func(sub stick.Subject) error

Mar 21, 2021

Changes in this version

type ClaimKey

+ Name string

type File

+ Name string

type Link

+ FileName string

+ Name string

type MemoryBlob

+ Name string

Jul 13, 2020

Changes in this version

type Link

+ Ref string

+ type Links []Link

+ func (l *Links) UnmarshalBSONValue(typ bsontype.Type, bytes []byte) error

+ func (l *Links) UnmarshalJSON(bytes []byte) error

+ func (l Links) Validate(name string, whitelist ...string) error

type Storage

+ func (s *Storage) DownloadFile(ctx context.Context, id coal.ID) (Download, *File, error)

Jun 5, 2020

Changes in this version

+ var ErrInvalidPosition = xo.BF("invalid position")

+ func ValidateType(str string, whitelist ...string) error

+ type Binding struct

+ Field string

+ Filename string

+ Limit int64

+ Name string

+ Owner coal.Model

+ Types []string

type ClaimKey

+ Size int64

+ Type string

type Download

+ Seek func(offset int64, whence int) (int64, error)

type File

+ Binding string

+ Owner *coal.ID

+ Size int64

type Link

+ FileSize int64

+ FileType string

+ Size int64

+ func (l *Link) Validate(name string, whitelist ...string) error

+ type MemoryBlob struct

+ Bytes []byte

+ Type string

+ type Register struct

+ func NewRegister() *Register

+ func (r *Register) Add(binding *Binding)

+ func (r *Register) Get(name string) *Binding

+ func (r *Register) Lookup(owner coal.Model, field string) *Binding

type Storage

+ func (s *Storage) ClaimFile(ctx context.Context, claimKey, binding string, owner coal.ID) (*File, error)

+ func (s *Storage) ClaimLink(ctx context.Context, link *Link, binding string, owner coal.ID) error

+ func (s *Storage) Modifier(fields ...string) *fire.Callback

+ func (s *Storage) ReleaseFile(ctx context.Context, file coal.ID) error

+ func (s *Storage) ReleaseLink(ctx context.Context, link *Link) error

May 4, 2020

Changes in this version

type GridFS

+ func (g *GridFS) Initialize(ctx context.Context) error

May 3, 2020

Changes in this version

+ func DownloadTo(download Download, writer io.Writer) error

+ func UploadFrom(upload Upload, reader io.Reader) (int64, error)

+ type Download interface

+ Close func() error

+ Read func(buf []byte) (int, error)

type Storage

+ func (s *Storage) Claim(ctx context.Context, link *Link) error

+ func (s *Storage) Decorate(link *Link) error

+ func (s *Storage) Download(ctx context.Context, viewKey string) (Download, *File, error)

+ func (s *Storage) Release(ctx context.Context, link *Link) error

+ func (s *Storage) Upload(ctx context.Context, contentType string, cb func(Upload) (int64, error)) (string, *File, error)

+ type Upload interface

+ Abort func() error

+ Close func() error

+ Write func(data []byte) (int, error)

Mar 25, 2020

Changes in this version

+ type CleanupJob struct

type File

+ func (f *File) Validate() error

type State

+ func (s State) Valid() bool

Jan 26, 2020

Changes in this version

+ var ErrInvalidHandle = errors.New("invalid handle")

+ var ErrNotFound = errors.New("not found")

+ var ErrUsedHandle = errors.New("used handle")

+ func AddFileIndexes(catalog *coal.Catalog)

+ type Blob struct

+ Bytes []byte

+ Type string

+ type ClaimKey struct

+ File coal.ID

+ func (k *ClaimKey) Validate() error

+ type File struct

+ Handle Handle

+ Length int64

+ State State

+ Type string

+ Updated time.Time

+ type GridFS struct

+ func NewGridFS(store *coal.Store, chunkSize int64) *GridFS

+ func (g *GridFS) Cleanup(_ context.Context) error

+ func (g *GridFS) Delete(ctx context.Context, handle Handle) (bool, error)

+ func (g *GridFS) Download(ctx context.Context, handle Handle, w io.Writer) error

+ func (g *GridFS) Prepare() (Handle, error)

+ func (g *GridFS) Upload(ctx context.Context, handle Handle, _ string, r io.Reader) (int64, error)

+ type Handle map[string]interface

+ type Link struct

+ ClaimKey string

+ File *coal.ID

+ Length int64

+ Type string

+ ViewKey string

+ type Memory struct

+ Blobs map[string]Blob

+ Next int

+ func NewMemory() *Memory

+ func (s *Memory) Cleanup(_ context.Context) error

+ func (s *Memory) Delete(_ context.Context, handle Handle) (bool, error)

+ func (s *Memory) Download(_ context.Context, handle Handle, w io.Writer) error

+ func (s *Memory) Prepare() (Handle, error)

+ func (s *Memory) Upload(_ context.Context, handle Handle, contentType string, r io.Reader) (int64, error)

+ type Service interface

+ Cleanup func(ctx context.Context) error

+ Delete func(ctx context.Context, handle Handle) (bool, error)

+ Download func(ctx context.Context, handle Handle, w io.Writer) error

+ Prepare func() (Handle, error)

+ Upload func(ctx context.Context, handle Handle, contentType string, r io.Reader) (int64, error)

+ type State string

+ const Claimed

+ const Deleting

+ const Released

+ const Uploaded

+ const Uploading

+ type Storage struct

+ func NewStorage(store *coal.Store, notary *heat.Notary, service Service) *Storage

+ func (s *Storage) Cleanup(ctx context.Context, retention time.Duration) error

+ func (s *Storage) CleanupTask(periodicity, retention time.Duration) *axe.Task

+ func (s *Storage) Decorator(fields ...string) *fire.Callback

+ func (s *Storage) DownloadAction() *fire.Action

+ func (s *Storage) UploadAction(limit int64) *fire.Action

+ func (s *Storage) Validator(fields ...string) *fire.Callback

+ type ViewKey struct

+ File coal.ID

+ func (k *ViewKey) Validate() error

Nov 22, 2017

Changes in this version

+ func C(store *coal.SubStore) *mgojq.Collection

+ func JobController(store *coal.Store, authorizers ...fire.Callback) *fire.Controller

+ type Job struct

+ Attempts int

+ Created time.Time

+ Delayed time.Time

+ Ended time.Time

+ Error string

+ Name string

+ Params bson.M

+ Reason string

+ Result bson.M

+ Started time.Time

+ Status string