tartrans

Documentation

Overview

The tar transmat packs filesystems into the widely-recognized "tar" format, and can use any k/v-styled warehouse for storage.

Index

• Constants
• Variables
• func Decompress(stream io.Reader) (io.Reader, error)
• func MetadataToTarHdr(fmeta *fs.Metadata, hdr *tar.Header)
• func Pack(ctx context.Context, packType api.PackType, pathStr string, ...) (_ api.WareID, err error)
• func TarHdrToMetadata(hdr *tar.Header, fmeta *fs.Metadata) (skipMe error, haltMe error)
• type Compression
  • func DetectCompression(source []byte) Compression
  • func (compression *Compression) Extension() string

Constants

const PackType = api.PackType("tar")

Variables

var (
	Mirror rio.MirrorFunc = util.CreateMirror(unpackTar)
	Scan   rio.ScanFunc   = util.CreateScanner(PackType, unpackTar)
	Unpack rio.UnpackFunc = util.CreateUnpack(PackType, unpackTar)
)

Functions

func Decompress

func Decompress(stream io.Reader) (io.Reader, error)

func MetadataToTarHdr

func MetadataToTarHdr(fmeta *fs.Metadata, hdr *tar.Header)

Mutate tar.Header fields to match the given fmeta.

func Pack

func Pack(
	ctx context.Context,
	packType api.PackType,
	pathStr string,
	filt api.FilesetPackFilter,
	warehouseAddr api.WarehouseLocation,
	mon rio.Monitor,
) (_ api.WareID, err error)

func TarHdrToMetadata

func TarHdrToMetadata(hdr *tar.Header, fmeta *fs.Metadata) (skipMe error, haltMe error)

Mutate fs.Metadata fields to match the given tar header. Does not check for names that go above '.'; caller may want to do that.

Types

type Compression

type Compression int

const (
	Uncompressed Compression = iota
	Bzip2
	Gzip
	Xz
)

func DetectCompression

func DetectCompression(source []byte) Compression

func (*Compression) Extension

func (compression *Compression) Extension() string