filesystem

package

v0.2.0-rc7 Latest Latest Go to latest Published: Apr 1, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Package filesystem provides an FS abstraction over operating system files overlaid with unsaved editor content.

This section is empty.

This section is empty.

This section is empty.

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

DocumentStore proves list and get facilities for unsaved documents.

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 New(docStore DocumentStore) *Filesystem

New creates an OS filesystem overlaid with the supplied document store.

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

Open implements fs.FS.

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

ReadDir provides entries under the supplied directory path.

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

ReadFile provides the content at the supplied path.

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

Stat provides file information at the supplied path.