suitcase

Documentation

Overview

Package suitcase holds all the stuff necessary for a suitecase generation

Index

• Constants
• func FormatCompletion(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)
• func WriteHashFile(hs []config.HashSet, o io.Writer) error
• func WriteHashFileBin(hs []config.HashSet, o io.Writer) error
• 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 FormatCompletion

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

FormatCompletion returns shell completion

func WriteHashFile

func WriteHashFile(hs []config.HashSet, o io.Writer) error

WriteHashFile writes out the hashset array to an io.Writer

func WriteHashFileBin

func WriteHashFileBin(hs []config.HashSet, o io.Writer) error

WriteHashFileBin writes out the hashset array to an io.Writer

Types

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) (*config.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