storage

Documentation

Index

• type Package
• type Packages
  • func (pkgs Packages) Len() int
  • func (pkgs Packages) Less(i, j int) bool
  • func (pkgs Packages) Swap(i, j int)
• type SqliteStore
  • func (s *SqliteStore) Close() error
  • func (s *SqliteStore) DoneToDo(name string, Continue bool) error
  • func (s *SqliteStore) GetForward(lhs string) (Packages, error)
  • func (s *SqliteStore) GetReverse(rhs string) (Packages, error)
  • func (s *SqliteStore) GetToDo() (Packages, int, int, error)
  • func (s *SqliteStore) Open(location string) error
  • func (s *SqliteStore) ResetToDo() error
  • func (s *SqliteStore) StartToDo(name string) error
  • func (s *SqliteStore) Update(i *index.Index) error
  • func (s *SqliteStore) WorstToDo(name string) (Packages, error)
• type Store
  • func NewSqliteStore() Store
  • func NewStore() Store

Types

type Package

type Package struct {
	Name    string `db:"name"`
	Release int    `db:"rel"`
}

Package is Storage's Representation of a Package

type Packages

type Packages []Package

Packages is a sortable type for a list of Package struct

func (Packages) Len

func (pkgs Packages) Len() int

Len returns the length of the list

func (Packages) Less

func (pkgs Packages) Less(i, j int) bool

Less is based on the names of the packages only

func (Packages) Swap

func (pkgs Packages) Swap(i, j int)

Swap switches the packages when sortint

type SqliteStore

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

SqliteStore is a backing store built on sqlite

func (*SqliteStore) Close

func (s *SqliteStore) Close() error

Close deinitializes the connection to the backend store

func (*SqliteStore) DoneToDo

func (s *SqliteStore) DoneToDo(name string, Continue bool) error

DoneToDo marks a package as complete and optionally queues its reverse deps

func (*SqliteStore) GetForward

func (s *SqliteStore) GetForward(lhs string) (Packages, error)

GetForward returns: (lhs) -> *

func (*SqliteStore) GetReverse

func (s *SqliteStore) GetReverse(rhs string) (Packages, error)

GetReverse returns: * -> (rhs)

func (*SqliteStore) GetToDo

func (s *SqliteStore) GetToDo() (Packages, int, int, error)

GetToDo gets the currently unblocked packages to rebuild

func (*SqliteStore) Open

func (s *SqliteStore) Open(location string) error

Open initializes a connection to the backend store

func (*SqliteStore) ResetToDo

func (s *SqliteStore) ResetToDo() error

ResetToDo clears the todo list

func (*SqliteStore) StartToDo

func (s *SqliteStore) StartToDo(name string) error

StartToDo adds a new package to the todo list

func (*SqliteStore) Update

func (s *SqliteStore) Update(i *index.Index) error

Update rebuilds the store from an Index

func (*SqliteStore) WorstToDo

func (s *SqliteStore) WorstToDo(name string) (Packages, error)

WorstToDo gets a worst-case list of packages to rebuild

type Store

type Store interface {
	// Open initializes a connection to the backend store
	Open(location string) error
	// GetForward returns: (left) -> *
	GetForward(lhs string) (Packages, error)
	// GetReverse returns: * -> (right)
	GetReverse(rhs string) (Packages, error)
	// GetToDo returns a list of unblocked packages that need to be rebuilt,
	// the count of remaining rebuilds, and the count of completed rebuilds
	GetToDo() (Packages, int, int, error)
	// StartToDo adds a new package to the todo list
	StartToDo(name string) error
	// DoneToDo marks a package as complete and optionally queues its reverse deps
	DoneToDo(name string, Continue bool) error
	// ResetToDo clears the todo list
	ResetToDo() error
	// WorstToDo gets a worst-case list of packages to rebuild
	WorstToDo(name string) (Packages, error)
	// Update clears the current store and rebuilds the contents from the provided index
	Update(i *index.Index) error
	// Close deinitializes the connection to the backend store
	Close() error
}

Store is a common interface for all kinds of backing store

func NewSqliteStore

func NewSqliteStore() Store

NewSqliteStore gets a new sqlite store

func NewStore

func NewStore() Store

NewStore gets a new version of the current preferred backing store