archive

package

v0.6.19 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/coffeebeats/gdenv

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Extract[T Archive](ctx context.Context, a artifact.Local[T], out string) error
func WithProgress(ctx context.Context, p *progress.Progress) context.Context
type Archivable
type Archive
type Local
type TarXZ
type Zip

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrExtractFailed = errors.New("extract failed")

Functions ¶

func Extract ¶

func Extract[T Archive](ctx context.Context, a artifact.Local[T], out string) error

Given a downloaded 'Archive', extract the contents and return a local 'Artifact' pointing to it.

func WithProgress ¶

func WithProgress(ctx context.Context, p *progress.Progress) context.Context

WithProgress creates a sub-context with an associated progress reporter. The result can be passed to the extract function(s) in this package to get updates on extraction progress.

Types ¶

type Archivable ¶

type Archivable interface {
	artifact.Artifact

	Archivable()
}

An interface representing an 'Artifact' that can be compressed into an archive.

type Archive ¶

type Archive interface {
	artifact.Artifact
	// contains filtered or unexported methods
}

An interface representing a compressed 'Artifact' archive.

type Local ¶

type Local = artifact.Local[Archive]

An alias for a locally-available 'Archive'.

type TarXZ ¶

type TarXZ[T Archivable] struct {
	Inner T
}

A struct representing an 'XZ'-compressed archive.

func (TarXZ[T]) Artifact ¶

func (a TarXZ[T]) Artifact()

Artifact "registers" 'TarXZ' as a Godot release artifact.

func (TarXZ[T]) Name ¶

func (a TarXZ[T]) Name() string

func (TarXZ[T]) Version ¶ added in v0.6.0

func (a TarXZ[T]) Version() version.Version

type Zip ¶

type Zip[T Archivable] struct {
	Inner T
}

A struct representing a 'zip'-compressed archive.

func (Zip[T]) Artifact ¶

func (a Zip[T]) Artifact()

Artifact "registers" 'Zip' as a Godot release artifact.

func (Zip[T]) Name ¶

func (a Zip[T]) Name() string

func (Zip[T]) Version ¶ added in v0.6.0

func (a Zip[T]) Version() version.Version

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL