ramstore

Documentation

Index

• Constants
• type Dir
  • func RootDir(debug bool) *Dir
  • func (d *Dir) Close() error
  • func (d *Dir) Delete(name string) error
  • func (d *Dir) Info() (fs.FileInfo, error)
  • func (d *Dir) List() []string
  • func (d *Dir) Mkdir(name string) error
  • func (d *Dir) Open(name string) (*File, error)
  • func (d *Dir) Readdir(n int) ([]fs.FileInfo, error)
  • func (d *Dir) Root(buffer string) (*Dir, error)
  • func (d *Dir) Walk(name string) (any, error)
• type DirInfo
  • func (di DirInfo) IsDir() bool
  • func (di DirInfo) ModTime() time.Time
  • func (di DirInfo) Mode() os.FileMode
  • func (di DirInfo) Name() string
  • func (di DirInfo) Size() int64
  • func (di DirInfo) Sys() any
• type File
  • func (f *File) Close() error
  • func (f *File) Name() string
  • func (f *File) Read(b []byte) (n int, err error)
  • func (f *File) Seek(offset int64, whence int) (int64, error)
  • func (f *File) Stat() (fs.FileInfo, error)
  • func (f *File) Truncate(cap int64) error
  • func (f *File) Write(p []byte) (n int, err error)
• type FileInfo
  • func (fi FileInfo) IsDir() bool
  • func (fi FileInfo) ModTime() time.Time
  • func (fi FileInfo) Mode() os.FileMode
  • func (fi FileInfo) Name() string
  • func (fi FileInfo) Size() int64
  • func (fi FileInfo) Sys() any

Constants

const (
	ErrInvalidTrunc = errRamstore("truncation invalid")
	ErrInvalidPath  = errRamstore("invalid path supplied")
	ErrInvalidDir   = errRamstore("invalid directory supplied")
	ErrShortSeek    = errRamstore("attempted negative seek")
	ErrSeekOver     = errRamstore("attempted seek past end of file")
	ErrDirExists    = errRamstore("directory exists")
	ErrFileClosed   = errRamstore("invalid action on closed file")
)

Types

type Dir

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

func RootDir

func RootDir(debug bool) *Dir

func (*Dir) Close

func (d *Dir) Close() error

func (*Dir) Delete

func (d *Dir) Delete(name string) error

func (*Dir) Info

func (d *Dir) Info() (fs.FileInfo, error)

func (*Dir) List

func (d *Dir) List() []string

func (*Dir) Mkdir

func (d *Dir) Mkdir(name string) error

func (*Dir) Open

func (d *Dir) Open(name string) (*File, error)

Open works by either returning a file/directory, or recursing if we are still rooted in a path

func (*Dir) Readdir

func (d *Dir) Readdir(n int) ([]fs.FileInfo, error)

func (*Dir) Root

func (d *Dir) Root(buffer string) (*Dir, error)

func (*Dir) Walk

func (d *Dir) Walk(name string) (any, error)

type DirInfo

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

func (DirInfo) IsDir

func (di DirInfo) IsDir() bool

func (DirInfo) ModTime

func (di DirInfo) ModTime() time.Time

func (DirInfo) Mode

func (di DirInfo) Mode() os.FileMode

func (DirInfo) Name

func (di DirInfo) Name() string

func (DirInfo) Size

func (di DirInfo) Size() int64

func (DirInfo) Sys

func (di DirInfo) Sys() any

type File

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

func (*File) Close

func (f *File) Close() error

func (*File) Name

func (f *File) Name() string

func (*File) Read

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

func (*File) Seek

func (f *File) Seek(offset int64, whence int) (int64, error)

func (*File) Stat

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

func (*File) Truncate

func (f *File) Truncate(cap int64) error

func (*File) Write

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

type FileInfo

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

func (FileInfo) IsDir

func (fi FileInfo) IsDir() bool

func (FileInfo) ModTime

func (fi FileInfo) ModTime() time.Time

func (FileInfo) Mode

func (fi FileInfo) Mode() os.FileMode

func (FileInfo) Name

func (fi FileInfo) Name() string

func (FileInfo) Size

func (fi FileInfo) Size() int64

func (FileInfo) Sys

func (fi FileInfo) Sys() any