generator

Documentation

Index

• Constants
• Variables
• func Bzip2(data []byte) ([]byte, error)
• func NewBzip2Writer(w io.Writer) (io.WriteCloser, error)
• func NewInstallInfo(r io.ReadSeeker) (*metadata.InstallInfo, error)
• type Generator
  • func (g *Generator) Partition(proc *Procedure) error
  • func (g *Generator) Write(path string) (err error)
• type Procedure
  • func FullUpdate(path string) (*Procedure, error)

Constants

const (
	// Default block size to use for all generated payloads.
	BlockSize = 4096

	// Default data size limit to process in a single operation.
	ChunkSize = BlockSize * 256
)

Variables

var (

	// ErrProcedureExists indicates that a given procedure type has
	// already been added to the Generator.
	ErrProcedureExists = errors.New("generator: procedure already exists")
)

Functions

func Bzip2

func Bzip2(data []byte) ([]byte, error)

Bzip2 simplifies using a Bzip2Writer when working with in-memory buffers.

func NewBzip2Writer

func NewBzip2Writer(w io.Writer) (io.WriteCloser, error)

NewBzip2Writer wraps a writer, compressing all data written to it.

func NewInstallInfo

func NewInstallInfo(r io.ReadSeeker) (*metadata.InstallInfo, error)

Types

type Generator

type Generator struct {
	destructor.MultiDestructor
	// contains filtered or unexported fields
}

Generator assembles an update payload from a number of sources. Each of its methods must only be called once, ending with Write.

func (*Generator) Partition

func (g *Generator) Partition(proc *Procedure) error

Partition adds the given /usr update Procedure to the payload. It must always be the first procedure added to the Generator.

func (*Generator) Write

func (g *Generator) Write(path string) (err error)

Write finalizes the payload, writing it out to the given file path.

type Procedure

type Procedure struct {
	metadata.InstallProcedure
	io.ReadCloser
}

Procedure represent independent update within a payload.

func FullUpdate

func FullUpdate(path string) (*Procedure, error)

FullUpdate generates an update Procedure for the given file, embedding its entire contents in the payload so it does not depend any previous state.