filesystem

Documentation

Index

• type DocumentStore
• type Filesystem
  • func NewFilesystem(docStore DocumentStore) *Filesystem
  • func (fs *Filesystem) Open(name string) (fs.File, error)
  • func (fs *Filesystem) ReadDir(name string) ([]fs.DirEntry, error)
  • func (fs *Filesystem) ReadFile(name string) ([]byte, error)
  • func (fs *Filesystem) SetLogger(logger *log.Logger)
  • func (fs *Filesystem) Stat(name string) (os.FileInfo, error)

Types

type DocumentStore

type DocumentStore interface {
	GetDocument(document.Handle) (*document.Document, error)
	ListDocumentsInDir(document.DirHandle) ([]*document.Document, error)
}

type Filesystem

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

Filesystem provides io/fs.FS compatible two-layer read-only filesystem with preferred source being DocumentStore and native OS FS acting as fallback.

This allows for reading files in a directory while reflecting unsaved changes.

func NewFilesystem

func NewFilesystem(docStore DocumentStore) *Filesystem

func (*Filesystem) Open

func (fs *Filesystem) Open(name string) (fs.File, error)

func (*Filesystem) ReadDir

func (fs *Filesystem) ReadDir(name string) ([]fs.DirEntry, error)

func (*Filesystem) ReadFile

func (fs *Filesystem) ReadFile(name string) ([]byte, error)

func (*Filesystem) SetLogger

func (fs *Filesystem) SetLogger(logger *log.Logger)

func (*Filesystem) Stat

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