Struct clap_help::Printer

pub struct Printer { /* private fields */ }

An object which you can configure to print the help of a command

Implementations

impl Printer

pub fn new(cmd: Command) -> Self

Examples found in repository

examples/area/main.rs (line 55)

fn main() {
    let args = Args::parse();

    if args.help {
        Printer::new(Args::command())
            .with_introduction(INTRO)
            .show_author(false)
            .print_help();
        return;
    }

    let (w, h) = (args.width, args.height);
    println!("Computation strategy: {:?}", args.strategy);
    println!("{w} x {h} = {}", w*h);
}

pub fn make_skin() -> MadSkin

Build a skin for the detected theme of the terminal (i.e. dark, light, or other)

pub fn with_skin(self, skin: MadSkin) -> Self

Use the provided skin

pub fn skin_mut(&mut self) -> &mut MadSkin

Give a mutable reference to the current skin (by default the automatically selected one) so that it can be modified

pub fn with_introduction(self, intro: &'static str) -> Self

Set the introduction text, interpreted as Markdown

Examples found in repository

examples/area/main.rs (line 56)

fn main() {
    let args = Args::parse();

    if args.help {
        Printer::new(Args::command())
            .with_introduction(INTRO)
            .show_author(false)
            .print_help();
        return;
    }

    let (w, h) = (args.width, args.height);
    println!("Computation strategy: {:?}", args.strategy);
    println!("{w} x {h} = {}", w*h);
}

pub fn show_author(self, b: bool) -> Self

Set whether to display the application author (default is true)

Examples found in repository

examples/area/main.rs (line 57)

fn main() {
    let args = Args::parse();

    if args.help {
        Printer::new(Args::command())
            .with_introduction(INTRO)
            .show_author(false)
            .print_help();
        return;
    }

    let (w, h) = (args.width, args.height);
    println!("Computation strategy: {:?}", args.strategy);
    println!("{w} x {h} = {}", w*h);
}

pub fn expander_mut(&mut self) -> &mut OwningTemplateExpander<'static>

pub fn print_template(&self, template: &str)

pub fn print_help(&self)

Print the whole help: title, author, introduction, usage, and options

To print only some parts, or to use custom templates, use print_template instead.

Examples found in repository

examples/area/main.rs (line 58)

fn main() {
    let args = Args::parse();

    if args.help {
        Printer::new(Args::command())
            .with_introduction(INTRO)
            .show_author(false)
            .print_help();
        return;
    }

    let (w, h) = (args.width, args.height);
    println!("Computation strategy: {:?}", args.strategy);
    println!("{w} x {h} = {}", w*h);
}