filesystem

Documentation

Index

• Constants
• Variables
• type File
• type Filesystem
  • func New(options ...Option) *Filesystem
  • func (fs *Filesystem) Get(path string) (*File, error)
  • func (fs *Filesystem) Has(path string) (bool, error)
  • func (fs *Filesystem) List(path string) ([]os.FileInfo, error)
  • func (fs *Filesystem) Save(path string, file File) error
  • func (fs *Filesystem) Stat(path string) (os.FileInfo, error)
• type Metadata
• type Option
  • func WithChroot(chrootDir string) Option

Constants

const DEFAULT_FILE_PERMISSIONS = 0644

Variables

var (
	ErrIsDir  = errors.New("is a directory")
	ErrIsFile = errors.New("is a file")
)

Types

type File

type File struct {
	Content  string
	Metadata Metadata
	FileInfo os.FileInfo
}

type Filesystem

type Filesystem struct {
	Filesystem         billy.Filesystem
	Error              error
	FilePermissionMode os.FileMode
	ChrootDirectory    string
}

func New

func New(options ...Option) *Filesystem

func (*Filesystem) Get

func (fs *Filesystem) Get(path string) (*File, error)

func (*Filesystem) Has

func (fs *Filesystem) Has(path string) (bool, error)

func (*Filesystem) List

func (fs *Filesystem) List(path string) ([]os.FileInfo, error)

func (*Filesystem) Save

func (fs *Filesystem) Save(path string, file File) error

func (*Filesystem) Stat

func (fs *Filesystem) Stat(path string) (os.FileInfo, error)

type Metadata

type Metadata struct {
	Permissions map[string][]string `json:"permissions"`
}

type Option

type Option func(*Filesystem) error

func WithChroot

func WithChroot(chrootDir string) Option