Skip to main content

Command

Enum Command 

Source
pub(crate) enum Command {
    Analyze {
        path: PathBuf,
        language: String,
        compile_commands: Option<PathBuf>,
        cpp_std: String,
        cache: Option<PathBuf>,
        no_system_headers: bool,
    },
    Query {
Show 16 fields project: PathBuf, language: String, compile_commands: Option<PathBuf>, cpp_std: String, functions: bool, callers: Option<String>, callees: Option<String>, unused: bool, dot: bool, cycles: bool, dead_code: bool, entries: String, complexity: bool, threshold: usize, cache: Option<PathBuf>, no_system_headers: bool,
}, Report { project: PathBuf, language: String, compile_commands: Option<PathBuf>, cpp_std: String, cache: Option<PathBuf>, no_system_headers: bool, output: PathBuf, }, Diff { old_project: PathBuf, new_project: PathBuf, language: String, compile_commands: Option<PathBuf>, cpp_std: String, cache: Option<PathBuf>, no_system_headers: bool, output: PathBuf, }, }
Expand description

Available subcommands.

Variants§

§

Analyze

Parse and display graph size.

Fields

§path: PathBuf

Path to source file or directory.

§language: String

Programming language (e.g. cpp, python).

§compile_commands: Option<PathBuf>

Path to compile_commands.json (C/C++).

§cpp_std: String

C++ standard version.

§cache: Option<PathBuf>

Path to cache file.

§no_system_headers: bool

Exclude system headers.

§

Query

Run queries on a project.

Fields

§project: PathBuf

Project path.

§language: String

Language.

§compile_commands: Option<PathBuf>

compile_commands.json (C/C++).

§cpp_std: String

C++ standard.

§functions: bool

List functions.

§callers: Option<String>

Show callers of a function.

§callees: Option<String>

Show callees of a function.

§unused: bool

List unused functions.

§dot: bool

Export DOT graph.

§cycles: bool

Detect call cycles.

§dead_code: bool

Detect dead code (requires –entries).

§entries: String

Entry points for dead code (comma separated).

§complexity: bool

Show complex functions.

§threshold: usize

Complexity threshold (AST nodes).

§cache: Option<PathBuf>

Cache file.

§no_system_headers: bool

Exclude system headers.

§

Report

Generate static HTML report.

Fields

§project: PathBuf

Project path.

§language: String

Language.

§compile_commands: Option<PathBuf>

compile_commands.json.

§cpp_std: String

C++ standard.

§cache: Option<PathBuf>

Cache file.

§no_system_headers: bool

Exclude system headers.

§output: PathBuf

Output file (default: report.html).

§

Diff

Diff two project versions.

Fields

§old_project: PathBuf

Old project path.

§new_project: PathBuf

New project path.

§language: String

Language.

§compile_commands: Option<PathBuf>

compile_commands.json.

§cpp_std: String

C++ standard.

§cache: Option<PathBuf>

Cache file.

§no_system_headers: bool

Exclude system headers.

§output: PathBuf

Output file (default: diff.html).

Trait Implementations§

Source§

impl FromArgMatches for Command

Source§

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

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

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

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Subcommand for Command

Source§

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

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut] Read more
Source§

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

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut] Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.