bundle

package

v1.0.1 Latest Latest Go to latest Published: Jan 5, 2024 License: MPL-2.0 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

This section is empty.

This section is empty.

func CreateBundlePath(bundleName, apiID string) (string, error)

CreateBundlePath returns the absolute path for a bundle, consisting of the combined API ID and hashed bundle name.

func LoadBundleManifest(bundle *Bundle, skipVerification bool) error

LoadBundleManifest will parse the manifest file and return the bundle parameters.

func SaveBundle(bundle *Bundle, destPath string) error

SaveBundle will save a bundle to the disk, see ZipBundleSaver methods for reference.

func SaveBundleZip(bundle *Bundle, apiID, bundleName string) error

type Bundle struct {
	Manifest apidef.BundleManifest
	Name     string
	Path     string
	Data     []byte
}

Bundle is the basic bundle data structure. It holds the bundle name and the data.

func LoadBundle(apiID, bundleName string) (*Bundle, error)

func (b *Bundle) Verify() error

Verify performs a signature verification on the bundle file.

type Getter interface {
	Get() ([]byte, error)
}

Getter is used for downloading bundle data, see HttpBundleGetter for reference.

type HTTPBundleGetter struct {
	URL string
}

HTTPBundleGetter is a simple HTTP Getter.

func (g *HTTPBundleGetter) Get() ([]byte, error)

Get performs an HTTP GET request.

type Saver interface {
	Save(*Bundle, string) error
}

Saver is an interface used by bundle saver structures.

type ZipBundleSaver struct{}

ZipBundleSaver is a Saver for ZIP files.

func (ZipBundleSaver) Save(bundle *Bundle, bundlePath string) error

Save implements the main method of the Saver interface. It makes use of archive/zip.