Struct HouseRules

pub struct HouseRules {
    pub fix: bool,
    pub only_diffed: bool,
    pub files: Vec<PathBuf>,
    pub skip_copyright: bool,
    pub skip_autogen_comment: bool,
    pub skip_package_info: bool,
    pub skip_trailing_newline: bool,
    pub skip_crate_name: bool,
    pub skip_repr_packed: bool,
    pub skip_cfg_target_arch: bool,
    pub skip_unsafe_code_comment: bool,
}

Fields

fix: bool

Attempt to fix formatting issues

only_diffed: bool

Only run checks on files that are currently diffed

files: Vec<PathBuf>

A list of files to check

If no files were provided, all files in-tree will be checked

skip_copyright: bool

Don’t run the copyright header check

skip_autogen_comment: bool

Don’t run the autogenerated Cargo.toml “see more keys” comment check

skip_package_info: bool

Don’t run the Cargo.toml author and version field checks

skip_trailing_newline: bool

Don’t run the trailing newline check

skip_crate_name: bool

Don’t run the crate name check

skip_repr_packed: bool

Don’t run the #[repr(packed)] check

skip_cfg_target_arch: bool

Don’t run the #[cfg(target_arch)] check

skip_unsafe_code_comment: bool

Don’t run the #[expect(unsafe_code)] comment check

Implementations

impl HouseRules

pub fn all_passes(fix: bool, only_diffed: bool) -> HouseRules

Initialize HouseRules with all passes enabled

Trait Implementations

impl Args for HouseRules

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::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 HouseRules

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 FromArgMatches for HouseRules

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 HouseRules

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::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][Error::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][Error::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.

impl Xtask for HouseRules

fn run(self, ctx: XtaskCtx) -> Result<()>

Run the Xtask.