Struct AppHelp

pub struct AppHelp<'a, W> { /* private fields */ }

Implementations

impl<'a, W: Write> AppHelp<'a, W>

pub fn new<S: Into<Cow<'a, str>>>( name: S, head: S, foot: S, style: Style, writer: W, max_width: usize, usage_new_line: usize, ) -> Self

pub fn with_global<S: Into<Cow<'a, str>>>( self, name: S, head: S, foot: S, ) -> Self

pub fn foot(&self) -> Cow<'a, str>

pub fn head(&self) -> Cow<'a, str>

pub fn name(&self) -> Cow<'a, str>

pub fn style(&self) -> &Style

pub fn wrap_max_width(&self) -> usize

pub fn usage_new_line(&self) -> usize

pub fn global(&self) -> &Command<'a>

pub fn global_mut(&mut self) -> &mut Command<'a>

pub fn block(&self) -> &[Block<'a, Cow<'a, str>>]

pub fn block_mut(&mut self) -> &mut [Block<'a, Cow<'a, str>>]

pub fn has_cmd(&self) -> bool

If the app has command except global one.

pub fn has_pos(&self) -> bool

If the app has position args in any command.

pub fn find_cmd<S: Into<Cow<'a, str>>>(&self, cmd: S) -> Option<&Command<'a>>

pub fn find_cmd_mut<S: Into<Cow<'a, str>>>( &mut self, cmd: S, ) -> Option<&mut Command<'a>>

pub fn find_block<S: Into<Cow<'a, str>>>( &self, block: S, ) -> Option<&Block<'a, Cow<'a, str>>>

pub fn find_block_mut<S: Into<Cow<'a, str>>>( &mut self, block: S, ) -> Option<&mut Block<'a, Cow<'a, str>>>

pub fn with_name<S: Into<Cow<'a, str>>>(self, name: S) -> Self

pub fn with_head<S: Into<Cow<'a, str>>>(self, head: S) -> Self

pub fn with_foot<S: Into<Cow<'a, str>>>(self, foot: S) -> Self

pub fn with_style(self, style: Style) -> Self

pub fn with_writer(self, writer: W) -> Self

pub fn set_name<S: Into<Cow<'a, str>>>(&mut self, name: S) -> &mut Self

pub fn set_head<S: Into<Cow<'a, str>>>(&mut self, head: S) -> &mut Self

pub fn set_foot<S: Into<Cow<'a, str>>>(&mut self, foot: S) -> &mut Self

pub fn set_style(&mut self, style: Style) -> &mut Self

pub fn set_write(&mut self, writer: W) -> &mut Self

pub fn add_block(&mut self, block: Block<'a, Cow<'a, str>>) -> Result<&mut Self>

pub fn add_cmd<S: Into<Cow<'a, str>>>( &mut self, block: S, cmd: Command<'a>, ) -> Result<&mut Self>

pub fn new_block<S: Into<Cow<'a, str>>>( &mut self, name: S, ) -> Result<AddBlock2App<'a, '_>>

pub fn new_cmd<S: Into<Cow<'a, str>>>( &mut self, block: S, name: S, ) -> Result<AddCmd2App<'a, '_, W>>

pub fn display(&mut self, show_global: bool) -> Result<()>

pub fn display_with<P>(&mut self, policy: P) -> Result<()>

where P: HelpPolicy<'a, Self>,

pub fn display_cmd<S>(&mut self, cmd: S) -> Result<()>

where S: Into<Cow<'a, str>>,

pub fn display_cmd_with<S, P>(&mut self, cmd: S, policy: P) -> Result<()>

where P: HelpPolicy<'a, Command<'a>>, S: Into<Cow<'a, str>>,

Trait Implementations

impl<'a, W: Clone> Clone for AppHelp<'a, W>

fn clone(&self) -> AppHelp<'a, W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, W: Debug> Debug for AppHelp<'a, W>

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

Formats the value using the given formatter.

impl Default for AppHelp<'_, Stdout>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, W: Write> HelpPolicy<'a, AppHelp<'a, W>> for DefaultAppPolicy<'a, AppHelp<'a, W>>

fn format(&self, app: &AppHelp<'a, W>) -> Option<Cow<'a, str>>