Struct CheckArgs 

pub struct CheckArgs {

    pub playset_path: Option<PathBuf>,
    pub format: CheckOutputFormat,
    pub output: Option<PathBuf>,
    pub strict: bool,
    pub analysis_mode: AnalysisModeArg,
    pub channel: CheckChannelArg,
    pub parse_issue_report: Option<PathBuf>,
    pub no_game_base: bool,
    pub no_color: bool,
    pub fix: bool,
    pub unsafe_fixes: bool,
    pub diff: bool,
    pub patch_mod: Option<PathBuf>,
    pub in_place: bool,
    pub restore: Option<PathBuf>,
    pub config: Option<PathBuf>,
}

Fields

playset_path: Option<PathBuf>

format: CheckOutputFormat

output: Option<PathBuf>

strict: bool

analysis_mode: AnalysisModeArg

channel: CheckChannelArg

parse_issue_report: Option<PathBuf>

no_game_base: bool

Skip loading vanilla game files; the lowest-precedence enabled mod is treated as a synthetic base for diff-and-merge.

no_color: bool

fix: bool

Fix the syntax errors Foch repairs by itself, as a linter’s –fix. A mod directory is fixed in place; a playset needs –patch-mod or –in-place. Exits with 1 while errors remain unfixed.

unsafe_fixes: bool

Also apply unsafe fixes, which settle what a merge holds for review: leave out a statement that cannot be read with confidence, or apply the likeliest repair of a definition that cannot be read at all.

diff: bool

Show the fixes as a unified diff and write nothing. Exits with 1 when there is something to fix.

patch_mod: Option<PathBuf>

With –fix: write a patch mod holding only the fixed files into this new or empty directory, to load after the mods it fixes, instead of changing them.

in_place: bool

With –fix on a playset or a Steam Workshop mod: fix the mods’ own files, after backing up each original, as a mod directory of one’s own is fixed. Steam replaces a Workshop mod’s files when it updates, which undoes the fix.

restore: Option<PathBuf>

Put back the originals an earlier in-place –fix backed up into this directory, for each file that still holds the fixed bytes.

config: Option<PathBuf>

Load reviewed repairs from this foch.toml instead of the default search path.

Trait Implementations

impl Args for CheckArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for CheckArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for CheckArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CheckArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CheckArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.