build

Documentation

Overview

Package build implements tools and function to build mindpaks. The main builder is build.Packer that writes the bundles to archives.

Index

• type InitOptions
  • func (opts *InitOptions) Validate() error
• type Packer
  • func NewPacker() *Packer
  • func (_ *Packer) InitBundle(opts *InitOptions) (*mindpak.Bundle, error)
  • func (_ *Packer) Write(bundle *mindpak.Bundle, w io.Writer) error
  • func (p *Packer) WriteToFile(bundle *mindpak.Bundle, path string) error

Types

type InitOptions

type InitOptions struct {
	*mindpak.Metadata
	Path string
}

InitOptions are used when initializing a new bundle directory.

func (*InitOptions) Validate

func (opts *InitOptions) Validate() error

Validate checks the initializer options

type Packer

type Packer struct{}

Packer handles writing the bundles to archives on disk.

func NewPacker

func NewPacker() *Packer

NewPacker returns a new packer object with the default options

func (*Packer) InitBundle

func (_ *Packer) InitBundle(opts *InitOptions) (*mindpak.Bundle, error)

InitBundle creates a new bundle manifest in a directory with minder data in the expected structure.

func (*Packer) Write

func (_ *Packer) Write(bundle *mindpak.Bundle, w io.Writer) error

Write writes a bundle archive to writer w

func (*Packer) WriteToFile

func (p *Packer) WriteToFile(bundle *mindpak.Bundle, path string) error

WriteToFile writes the bundle to a file on disk.