Struct RetirementRequest 

pub struct RetirementRequest<'a> {
    pub root: &'a Path,
    pub workspaces: &'a [WorkspaceInfo],
    pub sites: Vec<RetirementSiteInput>,
    pub in_scope: &'a dyn Fn(&Path) -> bool,
    pub whole_project: bool,
    pub age_mode: FlagAgeMode,
    pub cache_dir: Option<&'a Path>,
    pub progress: Option<&'a (dyn Fn(PickaxeProgress) + Sync)>,
    pub vendor_export: Option<&'a VendorExport>,
    pub vendor_key_prefix: Option<&'a str>,
    pub max_flag_age: Option<u64>,
    pub options: RetirementOptions,
}

Inputs of one retirement report.

Fields

root: &'a Path

Project root. Paths in the report are relative to it.

workspaces: &'a [WorkspaceInfo]

Workspaces of the project, for the flag identity.

sites: Vec<RetirementSiteInput>

Every flag site of the project, also outside the scope of the run.

in_scope: &'a dyn Fn(&Path) -> bool

Whether a file is in the scope of the run.

whole_project: bool

Whether the run covers the whole project. Only such a run adds vendor-only rows.

age_mode: FlagAgeMode

How to measure flag age.

cache_dir: Option<&'a Path>

Directory for the age cache, or None to run without the cache.

progress: Option<&'a (dyn Fn(PickaxeProgress) + Sync)>

Receives pickaxe progress.

vendor_export: Option<&'a VendorExport>

The --flag-state export, if any.

vendor_key_prefix: Option<&'a str>

flags.vendorKeyPrefix.

max_flag_age: Option<u64>

--max-flag-age, in days.

options: RetirementOptions

Filters, order and limit of the rows.