vfs

Documentation

Index

• func CrashOnWrite(reason string)
• func Init() error
• func MoveAwayState(kind StateKind, name string) error
• func OSCreate(root OSRoot, name string) (writeFile, error)
• func OSOpen(root OSRoot, name string) (readFile, error)
• func ReadDir(purpose string) ([]string, error)
• func ReadState(kind StateKind, name string) ([]byte, error)
• func SetFilesDir(dir string)
• func WriteState(kind StateKind, name string, data []byte) error
• type OSRoot
• type ReadSeekCloser
  • func Load(purpose, name string) (ReadSeekCloser, error)
  • func LoadPath(purpose, name string) (ReadSeekCloser, error)
• type StateKind

Functions

func CrashOnWrite

func CrashOnWrite(reason string)

CrashOnWrite prevents further writing to any state.

This is used as a safety mechanism so demo playback cannot have any influence on the system, and to ensure that demo playback's write attempts are properly redirected to memory buffers for regression testing.

func Init

func Init() error

Init initializes the VFS. Must be called before loading anything.

func MoveAwayState

func MoveAwayState(kind StateKind, name string) error

MoveAwayState renames a detected-to-be-broken state file so it will not be used again.

func OSCreate

func OSCreate(root OSRoot, name string) (writeFile, error)

func OSOpen

func OSOpen(root OSRoot, name string) (readFile, error)

func ReadDir

func ReadDir(purpose string) ([]string, error)

ReadDir lists all files in a directory. Returns their VFS paths!

func ReadState

func ReadState(kind StateKind, name string) ([]byte, error)

ReadState loads the given state file and returns its contents.

func SetFilesDir

func SetFilesDir(dir string)

SetFilesDir does nothing (on Android it'd be used to notify the Go code where to store its data).

func WriteState

func WriteState(kind StateKind, name string, data []byte) error

WriteState writes the given state file.

Types

type OSRoot

type OSRoot int

const (
	WorkDir OSRoot = iota
	ExeDir
)

type ReadSeekCloser

type ReadSeekCloser interface {
	io.Reader
	io.Seeker
	io.Closer
}

ReadSeekCloser is a typical file interface.

func Load

func Load(purpose, name string) (ReadSeekCloser, error)

func LoadPath

func LoadPath(purpose, name string) (ReadSeekCloser, error)

type StateKind

type StateKind int

const (
	Config StateKind = iota
	SavedGames
)