Documentation
¶
Index ¶
- Constants
- Variables
- func AccessPath(name string, objectPath string) string
- func Bind(app *runtime.App, manager *Manager) error
- func Close() error
- func CropImage(reader io.Reader, writer io.Writer, rect CropRect, format string, quality int) error
- func DefaultCDNURL() string
- func HookValidateFile(ctx context.Context, event Event) error
- func SetDefault(manager *Manager)
- func SourceHandler(fs *FileSystem, secret string) http.Handler
- func ValidateImageInfo(info ImageInfo, limit ImageLimit) error
- type Config
- type CropRect
- type DeleteResult
- type DownloadResult
- type DriverConfig
- type Event
- type FileHeader
- type FileInfo
- type FileStream
- type FileSystem
- type GetResult
- type Handler
- type Hook
- type HookOption
- func AfterDelete(hook Hook) HookOption
- func AfterDeleteFailed(hook Hook) HookOption
- func AfterDownload(hook Hook) HookOption
- func AfterDownloadFailed(hook Hook) HookOption
- func AfterGet(hook Hook) HookOption
- func AfterGetFailed(hook Hook) HookOption
- func AfterList(hook Hook) HookOption
- func AfterListFailed(hook Hook) HookOption
- func AfterSource(hook Hook) HookOption
- func AfterSourceFailed(hook Hook) HookOption
- func AfterToken(hook Hook) HookOption
- func AfterTokenFailed(hook Hook) HookOption
- func AfterUpload(hook Hook) HookOption
- func AfterUploadFailed(hook Hook) HookOption
- func BeforeDelete(hook Hook) HookOption
- func BeforeDownload(hook Hook) HookOption
- func BeforeGet(hook Hook) HookOption
- func BeforeList(hook Hook) HookOption
- func BeforeSource(hook Hook) HookOption
- func BeforeToken(hook Hook) HookOption
- func BeforeUpload(hook Hook) HookOption
- func HookMetadata(key string, value any) HookOption
- type ImageInfo
- type ImageLimit
- type ListResult
- type Manager
- func (m *Manager) AccessPath(name string, objectPath string) string
- func (m *Manager) Close() error
- func (m *Manager) Config(name string) (StoreConfig, error)
- func (m *Manager) Default() (*FileSystem, error)
- func (m *Manager) DefaultName() string
- func (m *Manager) New(policy Policy, opts ...Option) (*FileSystem, error)
- func (m *Manager) Policy(name string) (Policy, error)
- func (m *Manager) Use(name string) (*FileSystem, error)
- type Object
- type Option
- type Policy
- type SourceResult
- type StoreConfig
- type TokenResult
- type UploadChunkResult
- type UploadCredential
- type UploadInitRequest
- type UploadResult
- type UploadSession
- type UploadStatus
Constants ¶
View Source
const ( OperationUpload = pkgfs.OperationUpload OperationDownload = pkgfs.OperationDownload OperationGet = pkgfs.OperationGet OperationDelete = pkgfs.OperationDelete OperationList = pkgfs.OperationList OperationSource = pkgfs.OperationSource OperationToken = pkgfs.OperationToken UploadModeLocalChunk = core.UploadModeLocalChunk UploadModeDirectPut = core.UploadModeDirectPut UploadModeMultipartPut = core.UploadModeMultipartPut HookBeforeUpload = pkgfs.HookBeforeUpload HookAfterUpload = pkgfs.HookAfterUpload HookAfterUploadFailed = pkgfs.HookAfterUploadFailed HookBeforeDownload = pkgfs.HookBeforeDownload HookAfterDownload = pkgfs.HookAfterDownload HookAfterDownloadFailed = pkgfs.HookAfterDownloadFailed HookBeforeGet = pkgfs.HookBeforeGet HookAfterGet = pkgfs.HookAfterGet HookAfterGetFailed = pkgfs.HookAfterGetFailed HookBeforeDelete = pkgfs.HookBeforeDelete HookAfterDelete = pkgfs.HookAfterDelete HookAfterDeleteFailed = pkgfs.HookAfterDeleteFailed HookBeforeList = pkgfs.HookBeforeList HookAfterList = pkgfs.HookAfterList HookAfterListFailed = pkgfs.HookAfterListFailed HookBeforeSource = pkgfs.HookBeforeSource HookAfterSource = pkgfs.HookAfterSource HookAfterSourceFailed = pkgfs.HookAfterSourceFailed HookBeforeToken = pkgfs.HookBeforeToken HookAfterToken = pkgfs.HookAfterToken HookAfterTokenFailed = pkgfs.HookAfterTokenFailed )
View Source
const (
DefaultStoreName = "default"
)
View Source
const KeyStorage runtime.Key = "storage"
Variables ¶
View Source
var ( ErrNotConfigured = errors.New("storage: not configured") ErrDefaultRequired = errors.New("storage: default store is required") ErrStoreNotFound = errors.New("storage: store not found") )
View Source
var ( ErrFileTooBig = core.ErrFileTooBig ErrFileExists = core.ErrFileExists ErrFileNotFound = core.ErrFileNotFound ErrNameInvalid = core.ErrNameInvalid ErrUnknownDriver = core.ErrUnknownDriver ErrSourceExpired = core.ErrSourceExpired ErrSourceSignatureInvalid = core.ErrSourceSignatureInvalid ErrSourceSecretRequired = core.ErrSourceSecretRequired )
Functions ¶
func AccessPath ¶ added in v0.1.3
func DefaultCDNURL ¶ added in v0.1.3
func DefaultCDNURL() string
func SetDefault ¶
func SetDefault(manager *Manager)
func SourceHandler ¶
func SourceHandler(fs *FileSystem, secret string) http.Handler
func ValidateImageInfo ¶
func ValidateImageInfo(info ImageInfo, limit ImageLimit) error
Types ¶
type Config ¶
type Config struct {
Default string `mapstructure:"default" yaml:"default"`
Stores map[string]StoreConfig `mapstructure:"stores" yaml:"stores"`
}
type DeleteResult ¶
type DeleteResult = pkgfs.DeleteResult
type DownloadResult ¶
type DownloadResult = pkgfs.DownloadResult
type DriverConfig ¶
type DriverConfig = core.DriverConfig
type FileHeader ¶
type FileHeader = core.FileHeader
type FileStream ¶
type FileStream = core.FileStream
func NewFileStream ¶
func NewFileStream(reader io.Reader, info FileInfo) *FileStream
type FileSystem ¶
type FileSystem = pkgfs.FileSystem
func Default ¶
func Default() (*FileSystem, error)
func NewFileSystem ¶
func NewFileSystem(policy Policy, opts ...Option) (*FileSystem, error)
func NewFromPolicy ¶
func NewFromPolicy(policy core.StoragePolicy, opts ...pkgfs.Option) (*FileSystem, error)
func Use ¶
func Use(name string) (*FileSystem, error)
type HookOption ¶
type HookOption = pkgfs.HookOption
func AfterDelete ¶
func AfterDelete(hook Hook) HookOption
func AfterDeleteFailed ¶
func AfterDeleteFailed(hook Hook) HookOption
func AfterDownload ¶
func AfterDownload(hook Hook) HookOption
func AfterDownloadFailed ¶
func AfterDownloadFailed(hook Hook) HookOption
func AfterGet ¶
func AfterGet(hook Hook) HookOption
func AfterGetFailed ¶
func AfterGetFailed(hook Hook) HookOption
func AfterList ¶
func AfterList(hook Hook) HookOption
func AfterListFailed ¶
func AfterListFailed(hook Hook) HookOption
func AfterSource ¶
func AfterSource(hook Hook) HookOption
func AfterSourceFailed ¶
func AfterSourceFailed(hook Hook) HookOption
func AfterToken ¶
func AfterToken(hook Hook) HookOption
func AfterTokenFailed ¶
func AfterTokenFailed(hook Hook) HookOption
func AfterUpload ¶
func AfterUpload(hook Hook) HookOption
func AfterUploadFailed ¶
func AfterUploadFailed(hook Hook) HookOption
func BeforeDelete ¶
func BeforeDelete(hook Hook) HookOption
func BeforeDownload ¶
func BeforeDownload(hook Hook) HookOption
func BeforeGet ¶
func BeforeGet(hook Hook) HookOption
func BeforeList ¶
func BeforeList(hook Hook) HookOption
func BeforeSource ¶
func BeforeSource(hook Hook) HookOption
func BeforeToken ¶
func BeforeToken(hook Hook) HookOption
func BeforeUpload ¶
func BeforeUpload(hook Hook) HookOption
func HookMetadata ¶
func HookMetadata(key string, value any) HookOption
type ImageLimit ¶
type ImageLimit = pkgfs.ImageLimit
type ListResult ¶
type ListResult = pkgfs.ListResult
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func ManagerDefault ¶
func NewManager ¶
func (*Manager) AccessPath ¶ added in v0.1.3
func (*Manager) Default ¶
func (m *Manager) Default() (*FileSystem, error)
func (*Manager) DefaultName ¶
type Option ¶
func WithAllowedExtensions ¶
func WithChunkSize ¶
func WithMaxSize ¶
func WithNameRules ¶
func WithTempDir ¶
func WithTokenTTL ¶
type Policy ¶
type Policy = core.StoragePolicy
type SourceResult ¶
type SourceResult = pkgfs.SourceResult
type StoreConfig ¶
type StoreConfig struct {
Driver string `mapstructure:"driver" yaml:"driver"`
TempDir string `mapstructure:"temp_dir" yaml:"temp_dir"`
MaxSize int64 `mapstructure:"max_size" yaml:"max_size"`
ChunkSize int64 `mapstructure:"chunk_size" yaml:"chunk_size"`
TokenTTL time.Duration `mapstructure:"token_ttl" yaml:"token_ttl"`
DirRule string `mapstructure:"dir_rule" yaml:"dir_rule"`
FileRule string `mapstructure:"file_rule" yaml:"file_rule"`
AllowedExtensions []string `mapstructure:"allowed_extensions" yaml:"allowed_extensions"`
Name string `mapstructure:"name" yaml:"name"`
Bucket string `mapstructure:"bucket" yaml:"bucket"`
Endpoint string `mapstructure:"endpoint" yaml:"endpoint"`
EndpointInner string `mapstructure:"endpoint_inner" yaml:"endpoint_inner"`
CDNURL string `mapstructure:"cdn_url" yaml:"cdn_url"`
Region string `mapstructure:"region" yaml:"region"`
AccessKey string `mapstructure:"access_key" yaml:"access_key"`
SecretKey string `mapstructure:"secret_key" yaml:"secret_key"`
SecretID string `mapstructure:"secret_id" yaml:"secret_id"`
AccessKeyID string `mapstructure:"access_key_id" yaml:"access_key_id"`
AccessSecret string `mapstructure:"access_secret" yaml:"access_secret"`
Dir string `mapstructure:"dir" yaml:"dir"`
LocalDir string `mapstructure:"local_dir" yaml:"local_dir"`
Policy Policy `mapstructure:"policy" yaml:"policy"`
DriverConfig core.DriverConfig `mapstructure:",remain" yaml:",inline"`
}
func (StoreConfig) Clone ¶
func (c StoreConfig) Clone() StoreConfig
type TokenResult ¶
type TokenResult = pkgfs.TokenResult
type UploadChunkResult ¶
type UploadChunkResult = pkgfs.UploadChunkResult
type UploadCredential ¶
type UploadCredential = core.UploadCredential
type UploadInitRequest ¶
type UploadInitRequest = pkgfs.UploadInitRequest
type UploadResult ¶
type UploadResult = pkgfs.UploadResult
type UploadSession ¶
type UploadSession = pkgfs.UploadSession
type UploadStatus ¶
type UploadStatus = pkgfs.UploadStatus
Source Files
¶
Click to show internal directories.
Click to hide internal directories.