storage

Documentation

Index

• func RawPermissionsToMode(raw string) fs.FileMode
• func RegisterStorage(storageType string, ...)
• type ConfigProvider
  • func NewMapConfigProvider(m map[string]interface{}) ConfigProvider
• type FileInfo
  • func (f FileInfo) IsDir() bool
  • func (f FileInfo) ModTime() stdtime.Time
  • func (f FileInfo) Mode() fs.FileMode
  • func (f FileInfo) Name() string
  • func (f FileInfo) Size() int64
  • func (f FileInfo) Sys() any
• type Object
  • func (o Object) Info() (fs.FileInfo, error)
  • func (o Object) IsDir() bool
  • func (o Object) Name() string
  • func (o Object) Type() fs.FileMode
• type ObjectReader
  • func (o ObjectReader) Stat() (fs.FileInfo, error)
• type Storage
  • func NewClient(ctx context.Context, v ConfigProvider) (Storage, error)

Functions

func RawPermissionsToMode

func RawPermissionsToMode(raw string) fs.FileMode

func RegisterStorage

func RegisterStorage(storageType string, newFunc func(ctx context.Context, v ConfigProvider) (Storage, error))

Types

type ConfigProvider

type ConfigProvider interface {
	GetString(name string) string
	GetInt(name string) int
}

func NewMapConfigProvider

func NewMapConfigProvider(m map[string]interface{}) ConfigProvider

type FileInfo

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

func (FileInfo) IsDir

func (f FileInfo) IsDir() bool

func (FileInfo) ModTime

func (f FileInfo) ModTime() stdtime.Time

func (FileInfo) Mode

func (f FileInfo) Mode() fs.FileMode

func (FileInfo) Name

func (f FileInfo) Name() string

func (FileInfo) Size

func (f FileInfo) Size() int64

func (FileInfo) Sys

func (f FileInfo) Sys() any

type Object

type Object struct {
	Key          string
	LastModified stdtime.Time
	Size         int64
	ETag         string
	StorageClass string
	Mode         fs.FileMode
	Headers      http.Header
	Metadata     map[string]string
}

func (Object) Info

func (o Object) Info() (fs.FileInfo, error)

func (Object) IsDir

func (o Object) IsDir() bool

func (Object) Name

func (o Object) Name() string

func (Object) Type

func (o Object) Type() fs.FileMode

type ObjectReader

type ObjectReader struct {
	io.ReadCloser
	Object
}

func (ObjectReader) Stat

func (o ObjectReader) Stat() (fs.FileInfo, error)

type Storage

type Storage interface {
	fs.ReadDirFS
	json.Marshaler
	Type() string
	Name() string
	ListObject(ctx context.Context, objectPrefix string, recursion bool, callback func(key Object)) error
	HeadObject(ctx context.Context, objectPath string) (obj *Object, err error)
	GetObject(ctx context.Context, objectPath string) (*ObjectReader, error)
	PutObject(ctx context.Context, objectPath string, obj io.Reader, headers http.Header, metadata map[string]string) error
}

func NewClient

func NewClient(ctx context.Context, v ConfigProvider) (Storage, error)