Skip to main content

Module planner

Module planner 

Source

Structsยง

Candidate ๐Ÿ”’
A desired file with its reconciled content and what the file holds now.
Guards ๐Ÿ”’
The preconditions and dirty paths collected while planning.
Leftovers ๐Ÿ”’
Tracked paths that no declared file explains.
Plan
The filesystem changes needed to reach a desired file state.
Planner ๐Ÿ”’

Enumsยง

DirtyFiles
How Plan::apply treats paths whose current state Git cannot recover.
Operation
One filesystem change a Plan will make when applied.
PlanOrigin ๐Ÿ”’
What a Plan was built against.
Precondition ๐Ÿ”’
A condition Plan::apply checks before making any change.

Type Aliasesยง

CandidateMap ๐Ÿ”’
ExpectedUpdate ๐Ÿ”’
One caller-supplied (path, expected content, replacement content) entry for Plan::for_expected_updates.