slicer

Documentation

Index

• func SetDebug(debug bool)
• func SetLogger(logger log_Logger)
• type Report
  • func NewReport(root string) *Report
  • func Run(options *RunOptions) (*Report, error)
  • func (r *Report) Add(slice *setup.Slice, fsEntry *fsutil.Entry) error
• type ReportEntry
• type RunOptions

Functions

func SetDebug

func SetDebug(debug bool)

Enable the delivery of debug messages to the logger. Only meaningful if a logger is also set.

func SetLogger

func SetLogger(logger log_Logger)

Specify the *log.Logger object where log messages should be sent to.

Types

type Report

type Report struct {
	// Root is the filesystem path where the all reported content is based.
	Root string
	// Entries holds all reported content, indexed by their path.
	Entries map[string]ReportEntry
}

Report holds the information about files and directories created when slicing packages.

func NewReport

func NewReport(root string) *Report

NewReport returns an empty report for content that will be based at the provided root path.

func Run

func Run(options *RunOptions) (*Report, error)

func (*Report) Add

func (r *Report) Add(slice *setup.Slice, fsEntry *fsutil.Entry) error

type ReportEntry

type ReportEntry struct {
	Path   string
	Mode   fs.FileMode
	Hash   string
	Size   int
	Slices map[*setup.Slice]bool
	Link   string
}

type RunOptions

type RunOptions struct {
	Selection *setup.Selection
	Archives  map[string]archive.Archive
	TargetDir string
}