disk

Documentation

Index

• Constants
• func Barrier()
• func Init(d Disk)
• func Size() uint64
• func Write(a uint64, v Block)
• type Block
  • func Read(a uint64) Block
• type Disk
  • func Get() Disk
• type FileDisk
  • func NewFileDisk(path string, numBlocks uint64) (FileDisk, error)
  • func (d FileDisk) Barrier()
  • func (d FileDisk) Close()
  • func (d FileDisk) Read(a uint64) Block
  • func (d FileDisk) ReadTo(a uint64, buf Block)
  • func (d FileDisk) Size() uint64
  • func (d FileDisk) Write(a uint64, v Block)
• type MemDisk
  • func NewMemDisk(numBlocks uint64) MemDisk
  • func (d MemDisk) Barrier()
  • func (d MemDisk) Close()
  • func (d MemDisk) Read(a uint64) Block
  • func (d MemDisk) ReadTo(a uint64, buf Block)
  • func (d MemDisk) Size() uint64
  • func (d MemDisk) Write(a uint64, v Block)

Constants

const BlockSize uint64 = 4096

Functions

func Barrier

func Barrier()

Barrier (see the Disk documentation)

Deprecated: use Get() and the Disk method

func Init

func Init(d Disk)

Init sets up the global disk

func Size

func Size() uint64

Size (see the Disk documentation)

Deprecated: use Get() and the Disk method

func Write

func Write(a uint64, v Block)

Write (see the Disk documentation)

Deprecated: use Get() and the Disk method

Types

type Block

type Block = []byte

Block is a 4096-byte buffer

func Read

func Read(a uint64) Block

Read (see the Disk documentation)

Deprecated: use Get() and the Disk method

type Disk

type Disk interface {
	// Read reads a disk block by address
	//
	// Expects a < Size().
	Read(a uint64) Block

	// ReadTo reads the disk block at a and stores the result in b
	//
	// Expects a < Size().
	ReadTo(a uint64, b Block)

	// Write updates a disk block by address
	//
	// Expects a < Size().
	Write(a uint64, v Block)

	// Size reports how big the disk is, in blocks
	Size() uint64

	// Barrier ensures data is persisted.
	//
	// When it returns, all outstanding writes are guaranteed to be durably on
	// disk
	Barrier()

	// Close releases any resources used by the disk and makes it unusable.
	Close()
}

Disk provides access to a logical block-based disk

func Get

func Get() Disk

Get returns the previously-initialized global disk

type FileDisk

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

func NewFileDisk

func NewFileDisk(path string, numBlocks uint64) (FileDisk, error)

func (FileDisk) Barrier

func (d FileDisk) Barrier()

func (FileDisk) Close

func (d FileDisk) Close()

func (FileDisk) Read

func (d FileDisk) Read(a uint64) Block

func (FileDisk) ReadTo

func (d FileDisk) ReadTo(a uint64, buf Block)

func (FileDisk) Size

func (d FileDisk) Size() uint64

func (FileDisk) Write

func (d FileDisk) Write(a uint64, v Block)

type MemDisk

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

func NewMemDisk

func NewMemDisk(numBlocks uint64) MemDisk

func (MemDisk) Barrier

func (d MemDisk) Barrier()

func (MemDisk) Close

func (d MemDisk) Close()

func (MemDisk) Read

func (d MemDisk) Read(a uint64) Block

func (MemDisk) ReadTo

func (d MemDisk) ReadTo(a uint64, buf Block)

func (MemDisk) Size

func (d MemDisk) Size() uint64

func (MemDisk) Write

func (d MemDisk) Write(a uint64, v Block)