mfs

Documentation

Index

• Variables
• type Config
• type File
  • func (f *File) Fd() uint32
  • func (f *File) ReadAt(b []byte, off int64) (n int, err error)
  • func (f *File) String() string
  • func (f *File) WriteAt(b []byte, off int64) (n int, err error)
• type Volume
  • func Open(name string, cfg *Config) (v *Volume, err error)
  • func (v *Volume) Close()
  • func (v *Volume) Files() (ret []*File)
  • func (v *Volume) Name() string
  • func (v *Volume) Open(fd uint32) (f *File, err error)
  • func (v *Volume) String() string

Variables

var DefaultConfig = &Config{
	BlockSize: 1 << 20,
	RoundSize: 1 << 30,
}

DefaultConfig has the default value, with 1MB per block and 1GB per round.

Types

type Config

type Config struct {
	BlockSize int32
	RoundSize int64
}

Config is the global config for mfs.

type File

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

File is a high level interface which can be read or write at specified offset.

func (*File) Fd

func (f *File) Fd() uint32

Fd returns the unique file id in this volume.

func (*File) ReadAt

func (f *File) ReadAt(b []byte, off int64) (n int, err error)

ReadAt implements io.ReaderAt

func (*File) String

func (f *File) String() string

func (*File) WriteAt

func (f *File) WriteAt(b []byte, off int64) (n int, err error)

WriteAt implements io.WriterAt

type Volume

type Volume struct {
	*Config
	// contains filtered or unexported fields
}

Volume can have many files.

func Open

func Open(name string, cfg *Config) (v *Volume, err error)

Open an exist volume or create a new volume on disk.

func (*Volume) Close

func (v *Volume) Close()

Close unmap all mapped files

func (*Volume) Files

func (v *Volume) Files() (ret []*File)

Files returns all files in this volume.

func (*Volume) Name

func (v *Volume) Name() string

Name is the name, also the path of the volume

func (*Volume) Open

func (v *Volume) Open(fd uint32) (f *File, err error)

Open a file on volume to read and write.

func (*Volume) String

func (v *Volume) String() string