suitcase

Documentation

Overview

Package suitcase holds all the stuff necessary for a suitecase generation

Index

• Constants
• func FillWithInventoryIndex(s Suitcase, i *inventory.DirectoryInventory, index int, stateC chan FillState) ([]inventory.HashSet, error)
• func FormatCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
• func PostProcess(s Suitcase) error
• func WriteSuitcaseFile(so *config.SuitCaseOpts, i *inventory.DirectoryInventory, index int, ...) (string, error)
• type FillState
• type Format
  • func (f *Format) MarshalJSON() ([]byte, error)
  • func (f *Format) Set(v string) error
  • func (f Format) String() string
  • func (f Format) Type() string
• type Suitcase
  • func New(w io.Writer, opts *config.SuitCaseOpts) (Suitcase, error)

Constants

const (
	// NullFormat is the unset value for this type
	NullFormat = iota
	// TarFormat is for tar
	TarFormat
	// TarGzFormat is for tar.gz
	TarGzFormat
	// TarGzGpgFormat is for encrypted tar.gz (tar.gz.gpg)
	TarGzGpgFormat
	// TarGpgFormat is for encrypted tar.gz (tar.gpg)
	TarGpgFormat
	// TarZstFormat uses the zstd compression engine (tar.zst)
	TarZstFormat
	// TarZstGpgFormat uses the zstd compression engine with Gpg (tar.zst.gpg)
	TarZstGpgFormat
)

Functions

func FillWithInventoryIndex

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

FillWithInventoryIndex fills up a suitcase using the given inventory

func FormatCompletion

func FormatCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

FormatCompletion returns shell completion

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 Format

type Format int

Format is the format the inventory will use, such as yaml, json, etc

func (*Format) MarshalJSON

func (f *Format) MarshalJSON() ([]byte, error)

MarshalJSON ensures that json conversions use the string value here, not the int value

func (*Format) Set

func (f *Format) Set(v string) error

Set helps fulfill the pflag.Value interface

func (Format) String

func (f Format) String() string

func (Format) Type

func (f Format) Type() string

Type satisfies part of the pflags.Value interface

type Suitcase

type Suitcase interface {
	Close() error
	Add(inventory.File) (*inventory.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