Struct DocsArgs 

pub struct DocsArgs {
    pub topic: Option<String>,
    pub pager: bool,
    pub json: bool,
}

Arguments for dsp docs [topic].

Fields

topic: Option<String>

Topic to display. Omit to list all topics. Topics: dsp-cli, dsp, concepts, identifiers, connecting, output, workflows, errors, dsp-tools. Run dsp docs for one-line descriptions.

pager: bool

Page the output through $PAGER (default less).

json: bool

Emit the topic index as machine-readable JSON. Cannot be combined with a topic name or –pager.

Trait Implementations

impl Args for DocsArgs

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 Debug for DocsArgs

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

Formats the value using the given formatter.

impl FromArgMatches for DocsArgs

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.