updatechain

type Chain ¶

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

Chain is which file replaced which, for one mod. Its files can be of different kinds (main files, optional files, ...), each replaced by its own successors, but file ids are never shared so one Chain holds them all.

The zero Chain knows of no updates: every file is the latest.

func New(updates []Update) Chain

func (c Chain) Closest(candidates []int64) (index int, ok bool)

func (c Chain) Distance(fileID int64) int

func (c Chain) HasSuccessor(fileID int64) bool

func (c Chain) Head(fileID int64) int64

func (c Chain) Status(fileID int64, imported map[int64]struct{}) Status

type State ¶

type State int

State is where a file stands against the updates of its mod.

const (
	// UpToDate means that nothing has replaced the file.
	UpToDate State = iota
	// Superseded means that the file has been replaced by a newer one that is
	// already imported, so there is nothing to tell the user about.
	Superseded
	// UpdateAvailable means that the file has been replaced by a newer one
	// that is not imported (yet).
	UpdateAvailable
)

type Status ¶

type Status struct {
	State State

	// Head is the latest file of the chain: the file itself when it is
	// UpToDate.
	Head int64
}

Status is the outcome of Chain.Status.

type Update ¶

type Update struct {
	OldFileID int64
	NewFileID int64
}

Update is one link of a chain: NewFileID is the file that replaced OldFileID.