udisks

README

udisks

udisks gives you high level access to Linux system drives and block devices wrapping the udisk2 interfaces.

An example command line udisks client to list drives and block device properties can be installed with:

go install github.com/rubiojr/go-udisks/cmd/udisks@latest

package main

import (
	"encoding/json"
	"fmt"

	"os"

	"github.com/rubiojr/go-udisks"
)

func main() {
	client, err := udisks.NewClient()
	if err != nil {
		panic(err)
	}

	// List all block devices available to UDisks2
  devs, err := client.BlockDevices()
  if err != nil {
  	panic(err)
  }
  pretty(devs)
}

func pretty(dev interface{}) {
	prettyString, _ := json.MarshalIndent(dev, "", "  ")
	fmt.Println(string(prettyString))
}

Documentation

Index

• Variables
• type BlockDevice
• type Client
  • func NewClient() (*Client, error)
  • func (c *Client) BlockDevices() ([]*BlockDevice, error)
  • func (c *Client) Drives() ([]*Drive, error)
• type CryptoBackingDevice
• type Drive
• type Filesystem

Variables

var ErrInvalidDrive = errors.New("invalid drive")

Types

type BlockDevice

type BlockDevice struct {
	UUID                string
	Device              string
	Id                  string
	Drive               *Drive
	Filesystems         []Filesystem
	CryptoBackingDevice *CryptoBackingDevice
	Path                string
}

type Client

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

func NewClient

func NewClient() (*Client, error)

func (*Client) BlockDevices

func (c *Client) BlockDevices() ([]*BlockDevice, error)

BlockDevices returns the list of all block devices known to UDisks

func (*Client) Drives

func (c *Client) Drives() ([]*Drive, error)

Drives returns the list of all block devices known to UDisks

type CryptoBackingDevice

type CryptoBackingDevice struct {
	Path                string
	CleartextDevicePath string
	HintEncryptionType  string
	MetadataSize        uint64
}

type Drive

type Drive struct {
	Vendor         string
	Model          string
	Serial         string
	Id             string
	MediaRemovable bool
	Ejectable      bool
	MediaAvailable bool
	ConnectionBus  string
	SiblingId      string
	Seat           string
	Removable      bool
	Size           uint64
}

type Filesystem

type Filesystem struct {
	MountPoints []string
	Size        uint64
}