tools

Documentation

Index

• Variables
• type Filter
• type GUIArchive
• type List
  • func (src List) AllSeries() []string
  • func (src List) Arches() []string
  • func (src List) Exclude(excluded List) List
  • func (l List) Len() int
  • func (l List) Less(i, j int) bool
  • func (src List) Match(f Filter) (List, error)
  • func (src List) Newest() (version.Number, List)
  • func (src List) NewestCompatible(base version.Number) (newest version.Number, found bool)
  • func (src List) OneSeries() string
  • func (src List) String() string
  • func (l List) Swap(i, j int)
  • func (src List) URLs() map[version.Binary][]string
• type Tools
  • func (t *Tools) GetBSON() (interface{}, error)
  • func (t *Tools) SetBSON(raw bson.Raw) error

Variables

var ErrNoMatches = errors.New("no matching tools available")

Types

type Filter

type Filter struct {
	// Number, if non-zero, causes the filter to match only tools with
	// that exact version number.
	Number version.Number

	// Series, if not empty, causes the filter to match only tools with
	// that series.
	Series string

	// Arch, if not empty, causes the filter to match only tools with
	// that architecture.
	Arch string
}

Filter holds criteria for choosing tools.

type GUIArchive

type GUIArchive struct {
	Version version.Number `json:"version"`
	URL     string         `json:"url"`
	SHA256  string         `json:"sha256,omitempty"`
	Size    int64          `json:"size"`
}

GUI represents the location and version of a GUI release archive.

type List

type List []*Tools

List holds tools available in an environment. The order of tools within a List is not significant.

func (List) AllSeries

func (src List) AllSeries() []string

AllSeries returns all series for which some tools in src were built.

func (List) Arches

func (src List) Arches() []string

Arches returns all architectures for which some tools in src were built.

func (List) Exclude

func (src List) Exclude(excluded List) List

Exclude returns the tools in src that are not in excluded.

func (List) Len

func (l List) Len() int

func (List) Less

func (l List) Less(i, j int) bool

func (List) Match

func (src List) Match(f Filter) (List, error)

Match returns a List, derived from src, containing only those tools that match the supplied Filter. If no tools match, it returns ErrNoMatches.

func (List) Newest

func (src List) Newest() (version.Number, List)

Newest returns the greatest version in src, and the tools with that version.

func (List) NewestCompatible

func (src List) NewestCompatible(base version.Number) (newest version.Number, found bool)

NewestCompatible returns the most recent version compatible with base, i.e. with the same major and minor numbers and greater or equal patch and build numbers.

func (List) OneSeries

func (src List) OneSeries() string

OneSeries returns the single series for which all tools in src were built.

func (List) String

func (src List) String() string

String returns the versions of the tools in src, separated by semicolons.

func (List) Swap

func (l List) Swap(i, j int)

func (List) URLs

func (src List) URLs() map[version.Binary][]string

URLs returns download URLs for the tools in src, keyed by binary version. Each version can have more than one URL.

type Tools

type Tools struct {
	Version version.Binary `json:"version"`
	URL     string         `json:"url"`
	SHA256  string         `json:"sha256,omitempty"`
	Size    int64          `json:"size"`
}

Tools represents the location and version of a tools tarball.

func (*Tools) GetBSON

func (t *Tools) GetBSON() (interface{}, error)

GetBSON returns the structure to be serialized for the tools as a generic interface.

func (*Tools) SetBSON

func (t *Tools) SetBSON(raw bson.Raw) error

SetBSON updates the internal members with the data stored in the bson.Raw parameter.