Struct cargo_modules::options::graph::Options

pub struct Options {
    pub focus_on: Option<String>,
    pub max_depth: Option<usize>,
    pub with_types: bool,
    pub with_traits: bool,
    pub with_fns: bool,
    pub with_tests: bool,
    pub with_orphans: bool,
}

Fields

focus_on: Option<String>

Focus the graph on a particular path or use-tree’s environment, e.g. “foo:bar::{self, baz, blee::*}”.

max_depth: Option<usize>

The maximum depth of the generated graph relative to the crate’s root node, or nodes selected by ‘–focus-on’.

with_types: bool

Include types (e.g. structs, unions, enums).

with_traits: bool

Include traits (e.g. trait, unsafe trait).

with_fns: bool

Include functions (e.g. fns, async fns, const fns).

with_tests: bool

Include tests (e.g. #[test] fn …).

with_orphans: bool

Include orphaned modules (i.e. unused files in /src).

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl PartialEq<Options> for Options

fn eq(&self, other: &Options) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructOpt for Options

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Selfwhere
    Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>where
    Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Selfwhere
    Self: Sized,
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>where
    Self: Sized,
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.

impl Eq for Options

impl StructuralEq for Options

impl StructuralPartialEq for Options