arq

Documentation

Overview

Package arq implements read-only access to Arq backups stored on S3. Arq is a Mac backup tool (http://www.haystacksoftware.com/arq/) but the package can read the backups regardless of operating system.

Index

• type Computer
  • func (c *Computer) Folders() ([]*Folder, error)
  • func (c *Computer) Unlock(pw string)
• type Conn
  • func Dial(auth aws.Auth) (*Conn, error)
  • func (c *Conn) Computers() ([]*Computer, error)
  • func (c *Conn) DeleteCache()
• type Dirent
• type File
  • func (f *File) Lookup(name string) (*File, error)
  • func (f *File) Open() (io.ReadCloser, error)
  • func (f *File) ReadDir() ([]Dirent, error)
  • func (f *File) Stat() *Dirent
• type Folder
  • func (f *Folder) Load() error
  • func (f *Folder) Trees() ([]*Tree, error)
  • func (f *Folder) Trees2() ([]*Tree, error)
• type Tree
  • func (t *Tree) Root() (*File, error)

Types

type Computer

type Computer struct {
	Name string // name of computer
	User string // name of user
	UUID string
	// contains filtered or unexported fields
}

A Computer represents a computer with backups (Folders).

func (*Computer) Folders

func (c *Computer) Folders() ([]*Folder, error)

Folders returns a list of the folders that have been backed up on the computer.

func (*Computer) Unlock

func (c *Computer) Unlock(pw string)

Unlock records the password to use when decrypting backups from this computer. It must be called before calling Trees in any folder obtained for this computer.

type Conn

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

A Conn represents a connection to an S3 server holding Arq backups.

func Dial

func Dial(auth aws.Auth) (*Conn, error)

Dial establishes a connection to an S3 server holding Arq backups.

func (*Conn) Computers

func (c *Conn) Computers() ([]*Computer, error)

Computers returns a list of the computers with backups available on the S3 server.

func (*Conn) DeleteCache

func (c *Conn) DeleteCache()

type Dirent

type Dirent struct {
	Name    string
	ModTime time.Time
	Mode    os.FileMode
	Size    int64
}

type File

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

A File represents a file or directory in a tree.

func (*File) Lookup

func (f *File) Lookup(name string) (*File, error)

func (*File) Open

func (f *File) Open() (io.ReadCloser, error)

func (*File) ReadDir

func (f *File) ReadDir() ([]Dirent, error)

func (*File) Stat

func (f *File) Stat() *Dirent

type Folder

type Folder struct {
	Path string // root of tree of last backup
	// contains filtered or unexported fields
}

A Folder represents a backed-up tree on a computer.

func (*Folder) Load

func (f *Folder) Load() error

Load loads xxx

func (*Folder) Trees

func (f *Folder) Trees() ([]*Tree, error)

Trees returns a list of the individual backup snapshots for the folder. Note that different trees from the same Folder might have different Paths if the folder was "relocated" using the Arq interface.

func (*Folder) Trees2

func (f *Folder) Trees2() ([]*Tree, error)

type Tree

type Tree struct {
	Time  time.Time // time back-up completed
	Path  string    // root of backed-up tree
	Score [20]byte
	// contains filtered or unexported fields
}

A Tree represents a single backed-up file tree snapshot.

func (*Tree) Root

func (t *Tree) Root() (*File, error)

Root returns the File for the tree's root directory.