filesystem

Documentation

Index

• Constants
• Variables
• type App
  • func New(directory string) (App, error)
  • func (a App) CreateDir(name string) error
  • func (a App) Enabled() bool
  • func (a App) Info(pathname string) (model.Item, error)
  • func (a App) List(pathname string) ([]model.Item, error)
  • func (a App) Name() string
  • func (a App) Path(pathname string) string
  • func (a App) ReaderFrom(pathname string) (io.ReadSeekCloser, error)
  • func (a App) Remove(pathname string) error
  • func (a App) Rename(oldName, newName string) error
  • func (a App) UpdateDate(pathname string, date time.Time) error
  • func (a App) Walk(pathname string, walkFn func(model.Item) error) error
  • func (a App) WithIgnoreFn(ignoreFn func(model.Item) bool) model.Storage
  • func (a App) WriterTo(pathname string) (io.WriteCloser, error)

Constants

const Name = "fs"

Name of the storage implementation

Variables

var ErrRelativePath = errors.New("pathname contains relatives paths")

ErrRelativePath occurs when path is relative (contains ".."")

Types

type App

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

App of the package

func New

func New(directory string) (App, error)

New creates new App from Config

func (App) CreateDir

func (a App) CreateDir(name string) error

CreateDir container in storage

func (App) Enabled

func (a App) Enabled() bool

Enabled checks that requirements are met

func (App) Info

func (a App) Info(pathname string) (model.Item, error)

Info provide metadata about given pathname

func (App) List

func (a App) List(pathname string) ([]model.Item, error)

List items in the storage

func (App) Name

func (a App) Name() string

Name of the sotrage

func (App) Path

func (a App) Path(pathname string) string

Path return full path of pathname

func (App) ReaderFrom

func (a App) ReaderFrom(pathname string) (io.ReadSeekCloser, error)

ReaderFrom reads content from given pathname

func (App) Remove

func (a App) Remove(pathname string) error

Remove file or directory from storage

func (App) Rename

func (a App) Rename(oldName, newName string) error

Rename file or directory from storage

func (App) UpdateDate

func (a App) UpdateDate(pathname string, date time.Time) error

UpdateDate update date from given value

func (App) Walk

func (a App) Walk(pathname string, walkFn func(model.Item) error) error

Walk browses item recursively

func (App) WithIgnoreFn

func (a App) WithIgnoreFn(ignoreFn func(model.Item) bool) model.Storage

WithIgnoreFn create a new App with given ignoreFn

func (App) WriterTo

func (a App) WriterTo(pathname string) (io.WriteCloser, error)

WriterTo opens writer for given pathname