model

Documentation

Index

• Variables
• func Dirname(name string) string
• func ErrNotExist(err error) error
• func HandleClose(closer io.Closer, err error) error
• func ID(pathname string) string
• func IsNotExist(err error) bool
• type Item
  • func (s Item) Dir() string
• type Storage

Variables

var BufferPool = sync.Pool{
	New: func() any {
		return bytes.NewBuffer(make([]byte, 4*1024))
	},
}

BufferPool for io.CopyBuffer

Functions

func Dirname

func Dirname(name string) string

Dirname ensures given name is a dirname, with a trailing slash

func ErrNotExist

func ErrNotExist(err error) error

ErrNotExist create a NotExist error

func HandleClose

func HandleClose(closer io.Closer, err error) error

HandleClose call properly

func ID

func ID(pathname string) string

ID computes id of given pathname

func IsNotExist

func IsNotExist(err error) bool

IsNotExist checks if error match a not found

Types

type Item

type Item struct {
	Date      time.Time `json:"date"`
	ID        string    `json:"id"`
	Name      string    `json:"name"`
	Pathname  string    `json:"pathname"`
	Extension string    `json:"extension"`
	IsDir     bool      `json:"isDir"`
	Size      int64     `json:"size"`
}

Item describe item on a storage provider

func (Item) Dir

func (s Item) Dir() string

Dir return the nearest directory (self of parent)

type Storage

type Storage interface {
	Enabled() bool
	Name() string
	WithIgnoreFn(ignoreFn func(Item) bool) Storage
	Path(pathname string) string
	Info(ctx context.Context, pathname string) (Item, error)
	List(ctx context.Context, pathname string) ([]Item, error)
	WriteTo(ctx context.Context, pathname string, reader io.Reader) error
	WriteSizedTo(ctx context.Context, pathname string, size int64, reader io.Reader) error
	ReadFrom(ctx context.Context, pathname string) (io.ReadSeekCloser, error)
	Walk(ctx context.Context, pathname string, walkFn func(Item) error) error
	CreateDir(ctx context.Context, pathname string) error
	Rename(ctx context.Context, oldName, newName string) error
	Remove(ctx context.Context, pathname string) error
	UpdateDate(ctx context.Context, pathname string, date time.Time) error
	ConvertError(err error) error
}

Storage describe action on a storage provider