block

README

block

Package block enables programmatic access to block devices. MIT Licensed.

Documentation

Overview

Package block enables programmatic access to block devices.

Index

• Variables
• type Device
  • func New(device string, flags int) (*Device, error)
  • func (d Device) Close() error
  • func (d Device) Identify() ([512]byte, error)
  • func (d Device) Read(b []byte) (int, error)
  • func (d Device) ReadAt(b []byte, off int64) (int, error)
  • func (d Device) Seek(offset int64, whence int) (int64, error)
  • func (d Device) Size() (uint64, error)
  • func (d Device) Write(b []byte) (int, error)
  • func (d Device) WriteAt(b []byte, off int64) (int, error)

Variables

var (
	// ErrNotBlockDevice is returned when a device name passed to New is
	// not a block device.
	ErrNotBlockDevice = errors.New("not a block device")

	// ErrNotImplemented is returned when block device functionality is not
	// implemented on the current platform.
	ErrNotImplemented = errors.New("not implemented")
)

Types

type Device

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

A Device represents a block device. It can be used to query information about the device, seek the device, or read and write data.

func New

func New(device string, flags int) (*Device, error)

New attempts to open a block device with the specified flags, and verifies that device is a block device.

If device is not a block device, ErrNotBlockDevice is returned.

func (Device) Close

func (d Device) Close() error

Close closes the file descriptor for a block device.

func (Device) Identify

func (d Device) Identify() ([512]byte, error)

Identify queries a block device for its IDE identification info.

func (Device) Read

func (d Device) Read(b []byte) (int, error)

Read implements io.Reader for a block device.

func (Device) ReadAt

func (d Device) ReadAt(b []byte, off int64) (int, error)

ReadAt implements io.ReaderAt for a block device.

func (Device) Seek

func (d Device) Seek(offset int64, whence int) (int64, error)

Seek implements io.Seeker for a block device.

func (Device) Size

func (d Device) Size() (uint64, error)

Size queries a block device for its total size in bytes.

func (Device) Write

func (d Device) Write(b []byte) (int, error)

Write implements io.Writer for a block device.

func (Device) WriteAt

func (d Device) WriteAt(b []byte, off int64) (int, error)

WriteAt implements io.WriterAt for a block device.