archive

Documentation

Index

• Constants
• type Archive
  • func FromFormat(logger log.Logger, root string, format string, opts ...Option) Archive
• type Option
  • func WithCompressionLevel(i int) Option
  • func WithSkipSymlinks(b bool) Option

Constants

const (
	Gzip = "gzip"
	Tar  = "tar"
	Zstd = "zstd"

	DefaultCompressionLevel = flate.DefaultCompression
	DefaultArchiveFormat    = Tar
)

Types

type Archive

type Archive interface {
	// Create writes content of the given source to an archive, returns written bytes.
	// Similar to io.WriterTo.
	Create(srcs []string, w io.Writer) (int64, error)

	// Extract reads content from the given archive reader and restores it to the destination, returns written bytes.
	// Similar to io.ReaderFrom.
	Extract(dst string, r io.Reader) (int64, error)
}

Archive is an interface that defines exposed behavior of archive formats.

func FromFormat

func FromFormat(logger log.Logger, root string, format string, opts ...Option) Archive

FromFormat determines which archive to use from given archive format.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option overrides behavior of Archive.

func WithCompressionLevel

func WithCompressionLevel(i int) Option

WithCompressionLevel sets compression level option.

func WithSkipSymlinks

func WithSkipSymlinks(b bool) Option

WithSkipSymlinks sets skip symlink option.