archives

Documentation

Index

• func Build(c *corecmd.Core, infoLogger logg.LevelLogger, settings config.ArchiveSettings, ...) (err error)
• type Archiver
  • func New(settings config.ArchiveSettings, out io.WriteCloser) (Archiver, error)

Functions

func Build

func Build(c *corecmd.Core, infoLogger logg.LevelLogger, settings config.ArchiveSettings, req archiveplugin.Request) (err error)

Build builds an archive from the given settings and writes it to req.OutFilename

Types

type Archiver

type Archiver interface {
	// AddAndClose adds a file to the archive, then closes it.
	AddAndClose(dir string, f ioh.File) error

	// Finalize finalizes the archive and closes all writers in use.
	// It is not safe to call AddAndClose after Finalize.
	Finalize() error
}

func New

func New(settings config.ArchiveSettings, out io.WriteCloser) (Archiver, error)