Struct HelpView 

pub struct HelpView { /* private fields */ }

A renderable help page for a CommandSpec.

use rich::Console;
use rich_ext::cli_doc::{ArgSpec, CommandSpec, HelpView};

let spec = CommandSpec::new("tool")
    .arg(ArgSpec::option("level").choices(["low", "high"]).default_value("low").help("How much"));
let out = Console::builder().width(80).build().render_to_string(&HelpView::new(&spec));
assert!(out.contains("--level <LEVEL>  How much [default: low] [possible values: low, high]"));

Implementations

impl HelpView

pub fn new(spec: &CommandSpec) -> Self

pub fn for_path(root: &CommandSpec, path: &[&str]) -> Option<Self>

The help for the subcommand at path below root (such as ["config", "show"]), with the full command path in its usage.

pub fn long(self, long: bool) -> Self

Long help (--help): long about and long argument help where given, and a blank line between entries.

pub fn command_path(self, path: impl Into<String>) -> Self

The command as usage shows it, such as rich config.

Trait Implementations

impl Clone for HelpView

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpView

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

Formats the value using the given formatter.

impl Renderable for HelpView

fn rich_render(&self, c: &Console, o: &ConsoleOptions) -> Vec<Segment>

fn measure(&self, c: &Console, o: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. The default assumes the renderable fills the available width (e.g. Panel, Table); Text overrides it with its content width so the top-level print path can shrink to fit. Port of __rich_measure__ / Measurement.get.

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.