mirror

Documentation

Index

• Variables
• type Executable
• type GitHub
  • func (m GitHub) Domains() []string
  • func (m GitHub) ExecutableArchive(v version.Version, p platform.Platform) (artifact.Remote[executable.Archive], error)
  • func (m GitHub) ExecutableArchiveChecksums(v version.Version) (artifact.Remote[checksum.Executable], error)
  • func (m GitHub) SourceArchive(v version.Version) (artifact.Remote[source.Archive], error)
  • func (m GitHub) SourceArchiveChecksums(v version.Version) (artifact.Remote[checksum.Source], error)
  • func (m GitHub) Supports(v version.Version) bool
• type Mirror
  • func Select(ctx context.Context, v version.Version, p platform.Platform, mirrors []Mirror) (Mirror, error)
• type Source
• type TuxFamily
  • func (m TuxFamily) Domains() []string
  • func (m TuxFamily) ExecutableArchive(v version.Version, p platform.Platform) (artifact.Remote[executable.Archive], error)
  • func (m TuxFamily) ExecutableArchiveChecksums(v version.Version) (artifact.Remote[checksum.Executable], error)
  • func (m TuxFamily) SourceArchive(v version.Version) (artifact.Remote[source.Archive], error)
  • func (m TuxFamily) SourceArchiveChecksums(v version.Version) (artifact.Remote[checksum.Source], error)
  • func (m TuxFamily) Supports(v version.Version) bool

Variables

var (
	ErrInvalidSpecification = errors.New("invalid specification")
	ErrInvalidURL           = errors.New("invalid URL")
	ErrMissingMirrors       = errors.New("no mirrors provided")
	ErrNotFound             = errors.New("no mirror found")
	ErrNotSupported         = errors.New("mirror not supported")
)

Types

type Executable

type Executable interface {
	Mirror

	ExecutableArchive(v version.Version, p platform.Platform) (artifact.Remote[executable.Archive], error)
	ExecutableArchiveChecksums(v version.Version) (artifact.Remote[checksum.Executable], error)
}

Executable is a mirror which hosts Godot executable artifacts. This does not imply that *all* executable versions are hosted, so users should be prepared to handle the case where resolving the artifact URL fails.

type GitHub

type GitHub struct{}

A mirror implementation for fetching artifacts via releases on the Godot GitHub repository.

func (GitHub) Domains

func (m GitHub) Domains() []string

Returns a new 'client.Client' for downloading artifacts from the mirror.

func (GitHub) ExecutableArchive

func (m GitHub) ExecutableArchive(v version.Version, p platform.Platform) (artifact.Remote[executable.Archive], error)

func (GitHub) ExecutableArchiveChecksums

func (m GitHub) ExecutableArchiveChecksums(v version.Version) (artifact.Remote[checksum.Executable], error)

func (GitHub) SourceArchive

func (m GitHub) SourceArchive(v version.Version) (artifact.Remote[source.Archive], error)

func (GitHub) SourceArchiveChecksums

func (m GitHub) SourceArchiveChecksums(v version.Version) (artifact.Remote[checksum.Source], error)

func (GitHub) Supports

func (m GitHub) Supports(v version.Version) bool

Checks whether the version is broadly supported by the mirror. No network request is issued, but this does not guarantee the host has the version. To check whether the host has the version definitively via the network, use the 'checkIfExists' method.

type Mirror

type Mirror interface {
	// Domains returns a slice of domains at which the mirror hosts artifacts.
	Domains() []string

	// Checks whether the version is broadly supported by the mirror. No network
	// request is issued, but this does not guarantee the host has the version.
	// To check whether the host has the version definitively via the network,
	// use the 'Has' method.
	Supports(v version.Version) bool
}

Specifies a host of Godot release artifacts. The associated methods are related to the host itself and not about individual artifacts.

func Select

func Select(
	ctx context.Context,
	v version.Version,
	p platform.Platform,
	mirrors []Mirror,
) (Mirror, error)

Select chooses the best 'Mirror' of those provided for downloading assets corresponding to the specified version and platform of Godot.

type Source

type Source interface {
	Mirror

	SourceArchive(v version.Version) (artifact.Remote[source.Archive], error)
	SourceArchiveChecksums(v version.Version) (artifact.Remote[checksum.Source], error)
}

Source is a mirror which hosts Godot repository source code versions. This does not imply that *all* executable versions are hosted, so users should be prepared to handle the case where resolving the artifact URL fails.

type TuxFamily

type TuxFamily struct{}

A mirror implementation for fetching artifacts via the Godot TuxFamily host.

func (TuxFamily) Domains

func (m TuxFamily) Domains() []string

Returns a new 'client.Client' for downloading artifacts from the mirror.

func (TuxFamily) ExecutableArchive

func (m TuxFamily) ExecutableArchive(
	v version.Version,
	p platform.Platform,
) (artifact.Remote[executable.Archive], error)

func (TuxFamily) ExecutableArchiveChecksums

func (m TuxFamily) ExecutableArchiveChecksums(v version.Version) (artifact.Remote[checksum.Executable], error)

func (TuxFamily) SourceArchive

func (m TuxFamily) SourceArchive(v version.Version) (artifact.Remote[source.Archive], error)

func (TuxFamily) SourceArchiveChecksums

func (m TuxFamily) SourceArchiveChecksums(v version.Version) (artifact.Remote[checksum.Source], error)

func (TuxFamily) Supports

func (m TuxFamily) Supports(v version.Version) bool

Checks whether the version is broadly supported by the mirror. No network request is issued, but this does not guarantee the host has the version. To check whether the host has the version definitively via the network, use the 'checkIfExists' method.