Struct Cli

pub struct Cli {
    pub paths: Vec<String>,
    pub remove_todo: bool,
    pub remove_fixme: bool,
    pub remove_doc: bool,
    pub ignore_patterns: Vec<String>,
    pub no_default_ignores: bool,
    pub dry_run: bool,
    pub verbose: bool,
    pub no_gitignore: bool,
    pub traverse_git_repos: bool,
    pub threads: usize,
}

Fields§

§paths: Vec<String>

Files or directories to process (supports glob patterns)

§remove_todo: bool

Remove TODO comments (normally preserved)

§remove_fixme: bool

Remove FIXME comments (normally preserved)

§remove_doc: bool

Remove documentation comments (normally preserved)

§ignore_patterns: Vec<String>

Additional patterns to preserve (beyond defaults)

§no_default_ignores: bool

Disable automatic preservation of linting directives

§dry_run: bool

Show what would be changed without modifying files

§verbose: bool

Show detailed processing information

§no_gitignore: bool

Ignore .gitignore rules when finding files

§traverse_git_repos: bool

Process files in nested git repositories

§threads: usize

Number of parallel threads (0 = number of CPU cores)

Implementations§

impl Cli

pub fn processing_options(&self) -> ProcessingOptions

Trait Implementations§

impl Args for Cli

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 Read more

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 Read more

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more

impl Debug for Cli

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

Formats the value using the given formatter. Read more

impl FromArgMatches for Cli

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more

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 Cli

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. Read more

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.

Auto Trait Implementations§

impl Freeze for Cli

impl RefUnwindSafe for Cli

impl Send for Cli

impl Sync for Cli

impl Unpin for Cli

impl UnwindSafe for Cli

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.