virtfs

Documentation

Index

• Constants
• type FS
  • func New() *FS
  • func (f *FS) Add(file *File) error
  • func (f *FS) Get(name string) (*File, bool)
  • func (f *FS) Open(name string) (fs.File, error)
  • func (f *FS) WriteFile(path string, data []byte, _ fs.FileMode) error
• type File
  • func NewFile(name string, data []byte, opts ...FileOption) *File
  • func (f *File) Close() error
  • func (f *File) IsDir() bool
  • func (f *File) ModTime() time.Time
  • func (f *File) Mode() fs.FileMode
  • func (f *File) Name() string
  • func (f *File) Read(p []byte) (n int, err error)
  • func (f *File) ReadOnly() bool
  • func (f *File) Size() int64
  • func (f *File) Stat() (fs.FileInfo, error)
  • func (f *File) String() string
  • func (f *File) Sys() any
  • func (f *File) Write(p []byte) (n int, err error)
• type FileOption
  • func Writable(w io.Writer) FileOption

Constants

const (
	// In WASI, the path separator is always `/`. https://wa.dev/wasi:filesystem
	PathSeparator = '/'
)

Types

type FS

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

FS is a simple in-memory file system that allows for read and write access to files. It's inspired by embed.FS from the standard library. It should be safe for concurrent use. Only top level files are supported, directories are not.

func New

func New() *FS

func (*FS) Add

func (f *FS) Add(file *File) error

func (*FS) Get

func (f *FS) Get(name string) (*File, bool)

func (*FS) Open

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

func (*FS) WriteFile

func (f *FS) WriteFile(path string, data []byte, _ fs.FileMode) error

type File

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

func NewFile

func NewFile(name string, data []byte, opts ...FileOption) *File

func (*File) Close

func (f *File) Close() error

func (*File) IsDir

func (f *File) IsDir() bool

func (*File) ModTime

func (f *File) ModTime() time.Time

func (*File) Mode

func (f *File) Mode() fs.FileMode

func (*File) Name

func (f *File) Name() string

func (*File) Read

func (f *File) Read(p []byte) (n int, err error)

func (*File) ReadOnly

func (f *File) ReadOnly() bool

func (*File) Size

func (f *File) Size() int64

func (*File) Stat

func (f *File) Stat() (fs.FileInfo, error)

func (*File) String

func (f *File) String() string

func (*File) Sys

func (f *File) Sys() any

func (*File) Write

func (f *File) Write(p []byte) (n int, err error)

type FileOption

type FileOption func(*File)

func Writable

func Writable(w io.Writer) FileOption