mirror

Documentation

Index

• Variables
• type GitHub
  • func (m GitHub[T]) Hosts() []string
  • func (m GitHub[T]) Name() string
  • func (m GitHub[T]) Remote(a T) (artifact.Remote[T], error)
• type Hoster
• type Mirror
  • func Select[T artifact.Artifact](ctx context.Context, mirrors []Mirror[T], a T) (Mirror[T], error)
• type Remoter
• type TuxFamily
  • func (m TuxFamily[T]) Hosts() []string
  • func (m TuxFamily[T]) Name() string
  • func (m TuxFamily[T]) Remote(a T) (artifact.Remote[T], error)

Variables

var (
	ErrInvalidURL          = errors.New("invalid URL")
	ErrMissingMirrors      = errors.New("no mirrors provided")
	ErrNotFound            = errors.New("no mirror found")
	ErrUnsupportedArtifact = errors.New("unsupported artifact")
)

Types

type GitHub

type GitHub[T artifact.Artifact] struct{}

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

func (GitHub[T]) Hosts

func (m GitHub[T]) Hosts() []string

Hosts returns the host URLs at which artifacts are hosted.

func (GitHub[T]) Name

func (m GitHub[T]) Name() string

Name returns the display name of the mirror.

func (GitHub[T]) Remote

func (m GitHub[T]) Remote(a T) (artifact.Remote[T], error)

Remote returns an 'artifact.Remote' wrapper around a specified artifact. The remote wrapper contains the URL at which the artifact can be downloaded.

type Hoster

type Hoster interface {
	// Hosts returns a slice of URL hosts at which the mirror hosts artifacts.
	Hosts() []string
}

Hoster is a mirror which describes the host URLs at which it hosts content. This can be used to restrict redirects when downloading artifacts, improving security.

type Mirror

type Mirror[T artifact.Artifact] interface {
	Hoster
	Remoter[T]

	Name() string
}

Mirror specifies a host of Godot release artifacts.

func Select

func Select[T artifact.Artifact](
	ctx context.Context,
	mirrors []Mirror[T],
	a T,
) (Mirror[T], error)

Select chooses the best 'Mirror' of those provided for downloading the specified Godot release artifact.

type Remoter

type Remoter[T artifact.Artifact] interface {
	Remote(a T) (artifact.Remote[T], error)
}

Remoter is a type that can resolve the URL at which a specified artifact is hosted. Provided artifacts must be versioned.

type TuxFamily

type TuxFamily[T artifact.Artifact] struct{}

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

func (TuxFamily[T]) Hosts

func (m TuxFamily[T]) Hosts() []string

Hosts returns the host URLs at which artifacts are hosted.

func (TuxFamily[T]) Name

func (m TuxFamily[T]) Name() string

Name returns the display name of the mirror.

func (TuxFamily[T]) Remote

func (m TuxFamily[T]) Remote(a T) (artifact.Remote[T], error)

Remote returns an 'artifact.Remote' wrapper around a specified artifact. The remote wrapper contains the URL at which the artifact can be downloaded.