archive

type Archive struct {
	// contains filtered or unexported fields
}

type Options struct {
	// Name is the archive name; it becomes the virtual root directory's name
	// when more than one root is added. Required in that case.
	Name string
	// Workers is the payload-read parallelism: 0 = GOMAXPROCS, 1 = fully
	// synchronous generation. Both modes produce byte-identical output.
	Workers int
	// Buffer is the reorder-buffer memory budget in bytes (async mode);
	// 0 = 64 MiB.
	Buffer int64
	// OnWarn receives non-fatal events; nil discards them.
	OnWarn func(Warning)
	// Scan carries scanner policy (SkipOnError, custom reader, quota
	// lookups) and the exclusion rules: Scan.Exclude patterns are recorded
	// in the archive the way proxmox-backup-client records its --exclude
	// options (a .pxarexclude-cli file emitted last in the v1 root, the v2
	// prelude record), Scan.PxarExcludeFiles honours .pxarexclude files, and
	// Scan.Filter is a free-form veto that leaves no trace in the archive.
	// The .pxarexclude-cli file is a 0600 regular file owned by the
	// process's real uid/gid with mtime 0, exactly as upstream writes it.
	// Its OnWarn field is ignored; scan warnings arrive at OnWarn above as
	// WarnSkipped (or WarnBadPattern for unparsable .pxarexclude lines).
	Scan scan.Options

	// Previous enables metadata change detection for GenerateV2: regular
	// files whose metadata and size match the previous snapshot are not
	// read; the payload stream references the previous snapshot's chunks
	// instead. The payload stream is then framed (see package reuse) and
	// must be uploaded with pbs.UploadPXARv2, which understands the framing.
	// nil reads everything.
	Previous *Previous
	// PaddingThreshold bounds the share of reused chunk bytes that belong
	// to files not in the new archive; 0 = DefaultPaddingThreshold.
	PaddingThreshold float64
}

type PayloadChunk struct {
	EndOffset uint64
	Digest    [32]byte
}

type Previous struct {
	// contains filtered or unexported fields
}

type ReuseStats struct {
	// Files is the number of regular files in the archive
	Files int
	// ReusedFiles were not read: their payload was referenced from the
	// previous snapshot's chunks
	ReusedFiles int
	// ReusedBytes is the content size of the reused files
	ReusedBytes uint64
	// InjectedBytes is the size of the previous chunks referenced, including
	// padding (bytes of neighbouring files inside boundary chunks)
	InjectedBytes uint64
	// RejectedRuns counts runs of unchanged files that were read anyway
	// because the boundary padding exceeded the threshold
	RejectedRuns int
}

type WarnKind int

type Warning struct {
	Kind   WarnKind
	Path   string
	Err    error // WarnSkipped: the scan error
	Bound  int64 // WarnSizeChanged: the size the archive committed to
	Actual int64 // WarnSizeChanged: the byte count the source yielded
}