Struct Scan 

pub struct Scan {
    pub entries: Vec<Entry>,
    pub skipped_cache: Vec<CacheRecord>,
    pub skipped_secret: Vec<SkipRecord>,
    pub skipped_noise: Vec<SkipRecord>,
    pub symlinks: Vec<SymlinkRecord>,
    pub no_link_report_applied: Vec<String>,
    pub kept_over_secret: Vec<KeptOverSecret>,
    pub worktrees: Vec<WorktreeRecord>,
    pub worktree_of: Option<WorktreeOrigin>,
}

Result of classifying a project root.

Fields

entries: Vec<Entry>

Everything that will be written to the archive, in walk order.

skipped_cache: Vec<CacheRecord>

Cache directories that were dropped, with the size of what went too.

skipped_secret: Vec<SkipRecord>

Secret-looking files that were dropped and reported.

skipped_noise: Vec<SkipRecord>

OS debris that was dropped — recorded so nothing leaves without a trace.

symlinks: Vec<SymlinkRecord>

Every symlink found, one record each, except those a no_link_report glob covered.

no_link_report_applied: Vec<String>

no_link_report globs that actually suppressed at least one link, in declaration order.

A rule that matched nothing does not appear: this records what the scan did, not what was configured.

kept_over_secret: Vec<KeptOverSecret>

Files a keep rule carried past a secret rule.

worktrees: Vec<WorktreeRecord>

Registered git worktrees discovered under .git/worktrees/.

worktree_of: Option<WorktreeOrigin>

Set when this root is itself a worktree of a repository elsewhere.

Implementations

impl Scan

pub fn total_bytes(&self) -> u64

Total byte count of regular files to be packed.

pub fn file_count(&self) -> u64

Number of regular files to be packed.

pub fn symlink_count(&self) -> u64

Number of symlinks to be packed.

Trait Implementations

impl Debug for Scan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Scan

fn default() -> Scan

Returns the “default value” for a type.