model

Documentation

Index

• Constants
• Variables
• func Dirname(name string) string
• func ErrNotExist(err error) error
• func ID(value string) string
• func IsNotExist(err error) bool
• func ValidPath(name string) error
• type File
• type Item
  • func (i Item) Dir() string
  • func (i Item) IsDir() bool
  • func (i Item) IsZero() bool
  • func (i Item) ModTime() time.Time
  • func (i Item) Mode() os.FileMode
  • func (i Item) Name() string
  • func (i Item) Size() int64
  • func (i Item) String() string
  • func (i Item) Sys() any
• type ReadAtSeekCloser
• type Storage
• type WriteOpts

Constants

const (
	DirectoryPerm   = 0o700
	RegularFilePerm = 0o600

	ReadFlag  = os.O_RDONLY
	WriteFlag = os.O_RDWR | os.O_CREATE | os.O_TRUNC
)

Variables

var (
	ErrRelativePath = errors.New("name contains relatives paths")
	ErrInvalidPath  = errors.New("name is invalid")
)

Functions

func Dirname

func Dirname(name string) string

func ErrNotExist

func ErrNotExist(err error) error

func ID

func ID(value string) string

func IsNotExist

func IsNotExist(err error) bool

func ValidPath

func ValidPath(name string) error

Types

type File

type File interface {
	ReadAtSeekCloser
	io.Writer
	Readdir(int) ([]fs.FileInfo, error)
	Stat() (fs.FileInfo, error)
}

type Item

type Item struct {
	Date       time.Time   `json:"date"      msg:"date"`
	ID         string      `json:"id"        msg:"id"`
	NameValue  string      `json:"name"      msg:"name"`
	Pathname   string      `json:"pathname"  msg:"pathname"`
	Extension  string      `json:"extension" msg:"extension"`
	SizeValue  int64       `json:"size"      msg:"size"`
	FileMode   os.FileMode `json:"fileMode"  msg:"fileMode"`
	IsDirValue bool        `json:"isDir"     msg:"isDir"`
}

func (Item) Dir

func (i Item) Dir() string

func (Item) IsDir

func (i Item) IsDir() bool

func (Item) IsZero

func (i Item) IsZero() bool

func (Item) ModTime

func (i Item) ModTime() time.Time

func (Item) Mode

func (i Item) Mode() os.FileMode

func (Item) Name

func (i Item) Name() string

func (Item) Size

func (i Item) Size() int64

func (Item) String

func (i Item) String() string

func (Item) Sys

func (i Item) Sys() any

type ReadAtSeekCloser

type ReadAtSeekCloser interface {
	io.ReadSeekCloser
	io.ReaderAt
}

type Storage

type Storage interface {
	Stat(ctx context.Context, name string) (Item, error)
	Mkdir(ctx context.Context, name string, perm os.FileMode) error
	Rename(ctx context.Context, oldName, newName string) error
	RemoveAll(ctx context.Context, name string) error

	Enabled() bool
	Name() string
	WithIgnoreFn(ignoreFn func(Item) bool) Storage
	Path(name string) string

	List(ctx context.Context, name string) ([]Item, error)
	WriteTo(ctx context.Context, name string, reader io.Reader, opts WriteOpts) error
	ReadFrom(ctx context.Context, name string) (ReadAtSeekCloser, error)
	Walk(ctx context.Context, name string, walkFn func(Item) error) error

	UpdateDate(ctx context.Context, name string, date time.Time) error
	ConvertError(err error) error
}

type WriteOpts

type WriteOpts struct {
	Size int64
}