suitcase

Documentation

Overview

Package suitcase holds all the stuff necessary for a suitecase generation

Index

• func FillWithInventoryIndex(s Suitcase, i *inventory.DirectoryInventory, index int, stateC chan FillState) ([]helpers.HashSet, error)
• func PostProcess(s Suitcase) error
• func WriteSuitcaseFile(so *config.SuitCaseOpts, i *inventory.DirectoryInventory, index int, ...) (string, error)
• type FillState
• type Suitcase
  • func New(w io.Writer, opts *config.SuitCaseOpts) (Suitcase, error)

Functions

func FillWithInventoryIndex

func FillWithInventoryIndex(s Suitcase, i *inventory.DirectoryInventory, index int, stateC chan FillState) ([]helpers.HashSet, error)

FillWithInventoryIndex fills up a suitcase using the given inventory

func PostProcess

func PostProcess(s Suitcase) error

PostProcess executes post processing commands

func WriteSuitcaseFile

func WriteSuitcaseFile(so *config.SuitCaseOpts, i *inventory.DirectoryInventory, index int, stateC chan FillState) (string, error)

WriteSuitcaseFile will write out the suitcase

Types

type FillState

type FillState struct {
	Current        uint
	Total          uint
	Completed      bool
	CurrentPercent float64
	Index          int
}

FillState is the current state of a suitcase file

type Suitcase

type Suitcase interface {
	Close() error
	Add(inventory.File) (*helpers.HashSet, error)
	AddEncrypt(f inventory.File) error
	Config() *config.SuitCaseOpts
}

Suitcase is the interface that describes what a Suitcase does

func New

func New(w io.Writer, opts *config.SuitCaseOpts) (Suitcase, error)

New Create a new suitcase