scan

type ACLs = pxar.ACLs

type Follower interface {
	Stat(path string) (Stat, error)
}

type Kind int

type MatchType int

type MetadataReader interface {
	Lstat(path string) (Stat, error)
	// ReadDirNames returns the child names of a directory sorted in byte
	// order — the order pxar archives require.
	ReadDirNames(path string) ([]string, error)
	Readlink(path string) (string, error)
	// Xattrs returns generic extended attributes sorted by name, excluding
	// those represented by dedicated records (POSIX ACLs, security.capability).
	Xattrs(path string) ([]Xattr, error)
	ACLs(path string) (*ACLs, error)
	FCaps(path string) ([]byte, error)
	// QuotaProjID returns the filesystem quota project id and whether one is
	// set (project id 0 counts as unset).
	QuotaProjID(path string) (uint64, bool, error)
	// ReadFile returns the contents of a regular file (the scanner reads
	// .pxarexclude files with it). A missing file must be reported with an
	// error satisfying errors.Is(err, fs.ErrNotExist).
	ReadFile(path string) ([]byte, error)
}

type Node struct {
	Name string // basename within the parent (archive naming)
	Path string // absolute source path; empty for virtual nodes
	Kind Kind

	Stat Stat

	// LinkTarget holds the symlink target (KindSymlink) or the
	// archive-relative path of the hardlink's first occurrence (KindHardlink).
	LinkTarget string

	Xattrs      []Xattr
	ACL         *ACLs
	FCaps       []byte
	QuotaProjID uint64 // 0 = none
	Children    []*Node

	// Stream backs KindStream nodes; Stat.Size holds the declared size.
	Stream io.Reader
}

type Options struct {
	// Reader overrides the platform MetadataReader (used in tests and by
	// future non-Linux implementations).
	Reader MetadataReader
	// SkipOnError downgrades per-entry scan failures to warnings, omitting
	// the entry, instead of failing the scan.
	SkipOnError bool
	// OnWarn receives warnings; nil discards them.
	OnWarn func(Warning)
	// SkipQuotaProjIDs disables the per-node quota project id lookup, which
	// costs one open+ioctl per directory and regular file.
	SkipQuotaProjIDs bool

	// Exclude lists exclude patterns in proxmox-backup-client syntax (see
	// Pattern), matched against archive-relative paths; an excluded
	// directory's subtree is not scanned. Invalid patterns fail NewScanner.
	// The archive package records these patterns in the archive the way the
	// official client does (.pxarexclude-cli in v1, the prelude in v2).
	Exclude []string
	// PxarExcludeFiles honours .pxarexclude files found in scanned
	// directories, like the official client: each line is a pattern
	// (Pattern syntax; '#' comments and blank lines ignored) applying to
	// that directory's subtree only, with anchored patterns relative to the
	// directory holding the file. Lines that fail to parse are reported to
	// OnWarn (with a *PatternError) and ignored; the file itself is
	// archived. Off by default: a library should not silently obey control
	// files found inside the data it backs up.
	PxarExcludeFiles bool
	// Filter, when set, is consulted for every entry below a root that the
	// patterns did not exclude; returning false omits the entry and its
	// subtree. It sees the on-disk path, the archive-relative path and the
	// entry's lstat data. Unlike Exclude it is never recorded in the archive.
	Filter func(path, archivePath string, st Stat) bool
	// OnExclude, when set, receives every entry omitted by Exclude, a
	// .pxarexclude file or Filter; nil discards them.
	OnExclude func(path, archivePath string)
}

type Pattern struct {
	Text     string // body: no leading '!' or '/', no trailing '/'
	Anchored bool   // leading '/'
	DirOnly  bool   // trailing '/'
	Include  bool   // leading '!'
	// contains filtered or unexported fields
}

type PatternError struct {
	Pattern string
	Err     error
}

type PatternList []Pattern

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

type Stat struct {
	Mode       uint64 // full st_mode: type + permission bits
	UID        uint32
	GID        uint32
	MtimeSecs  int64
	MtimeNanos uint32
	Size       int64  // regular files: byte size at scan time
	Nlink      uint64 // hardlink count
	Dev        uint64 // containing device (hardlink identity)
	Ino        uint64 // inode number (hardlink identity)
	Rdev       pxar.Device
}

type Warning struct {
	Path string
	Err  error
}

type Xattr = pxar.Xattr