Struct HelpPage 

pub struct HelpPage { /* private fields */ }

A full --help page: a name/version line, usage line(s), an optional blurb, a list of Sections, and an optional footer (e.g. fasthex’s size-suffix legend).

Implementations

impl HelpPage

pub fn new(name_line: impl Into<String>) -> Self

pub fn usage(self, line: impl Into<String>) -> Self

pub fn blurb(self, text: impl Into<String>) -> Self

pub fn section(self, section: Section) -> Self

pub fn footer(self, text: impl Into<String>) -> Self

pub fn desc_column(self, col: usize) -> Self

Override the description column (default 28, matching all four tools today).

pub fn theme(self, theme: Theme) -> Self

pub fn render(&self, color: bool) -> String

Render the page to a String. color is typically the resolved bool from ColorWhen::resolve.

pub fn print(&self, when: ColorWhen)

Render straight to stdout, resolving color from when.